![ポメラをつかって記事を書く](https://cdn-ak-scissors.b.st-hatena.com/image/square/aaeab53067180c6188df7494d445d343fbbc260c/height=288;version=1;width=512/https%3A%2F%2Fres.cloudinary.com%2Fzenn%2Fimage%2Fupload%2Fs--5vH7K1zh--%2Fc_fit%252Cg_north_west%252Cl_text%3Anotosansjp-medium.otf_55%3A%2525E3%252583%25259D%2525E3%252583%2525A1%2525E3%252583%2525A9%2525E3%252582%252592%2525E3%252581%2525A4%2525E3%252581%25258B%2525E3%252581%2525A3%2525E3%252581%2525A6%2525E8%2525A8%252598%2525E4%2525BA%25258B%2525E3%252582%252592%2525E6%25259B%2525B8%2525E3%252581%25258F%252Cw_1010%252Cx_90%252Cy_100%2Fg_south_west%252Cl_text%3Anotosansjp-medium.otf_37%3Atenntenn%252Cx_203%252Cy_121%2Fg_south_west%252Ch_90%252Cl_fetch%3AaHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL3plbm4tdXNlci11cGxvYWQvYXZhdGFyL2QzMTRhZjM1ZWIuanBlZw%3D%3D%252Cr_max%252Cw_90%252Cx_87%252Cy_95%2Fv1627283836%2Fdefault%2Fog-base-w1200-v2.png)
sentenceの活動の一環として、イベントや講座に呼んでいただき、初心者受けにライティングについて話す機会がある。 その際、いくつか必ず伝えようと思っていることを決めている。書く前に準備をすることが大事だという話や文章の基礎的なルールなどだ。 最近、新たに伝えるようになったことがある。それは、書くことのハードルを上げすぎないこと。 ほとんどの人は文章を書くことに抵抗感を持っている。意識しているか、無意識かは人によると思うけれど。 文章を執筆するための技法やノウハウを覚えたところで、上手く書こうとしている限りは、なかなか筆が進まない。 まずは、上手く書こうとするのをやめる必要がある。最初から上手く書ける人など(ほとんど)いないし、まずは書かなければ上達しない。 この点については、雑につくることについて伝えるエントリをいくつか紹介しておくので、参考にしてもらいたい。
ソフトウェアエンジニアの summerwind です。最近は LLM が自分のふりをして代わりに仕事をしてくれるような仕組み作りを趣味にしています。 先日社内で「ドキュメントをうまく書く方法はありますか?」という質問をもらったのですが、普段ドキュメントを書く時に意識をしている要素のようなものはあるものの、それをちゃんと言語化したことがなかったため、抽象的にしか答えることができませんでした。改めて言語化をしてみるのは面白そうだなと感じたので、今回はドキュメントを書く時に考えていることをいくつか書き出してみたいと思います。 想定する読者を決める ドキュメントを書く時にまず最初にやるのは「そのドキュメントの想定する読者は誰か」についてを考えることです。よくある想定読者には次のような方々がいます。 同じチームで働くエンジニアのメンバー 同じプロジェクトで働くメンバー 全メンバー 想定する読者が決ま
ドキュメントを書くときの工夫として「箇条書き」があります。 整理されている感じがあり、書き手・読み手のどちらにもメリットがありそうです。 しかし箇条書きを乱用すると、うまく情報が伝わないケースも出てきます。 もし「箇条書きにはしてるんだけど、"わかりづらい"と言われたことがある」という方がいれば、ぜひ読んでみてください。 「プロセス」としての箇条書きは「成果」ではない 書き手にとって、箇条書きは普通に文章を書くよりもスラスラ書けるはずです。 これは箇条書きが「思いついたことをどんどん書けるフォーマット」であり、言い換えれば「明確な論理構造を持たなくてよいフォーマット」だからです。 ゆえに、 Qiitaで箇条書きに関する記事を書くぞ どんな内容にしようか? まず箇条書きのデメリットを挙げてみるか 思いついたことは書けるけど論理はないかも 「論理構造」ってどう説明すればいいんだろう。ちゃんと調
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く