開発ドキュメントの書き方！9つのコツ【エンジニア】

テクノロジーカテゴリーの変更を依頼記事元:

applis.io

417 usersがブックマークコメント

コメント

6

記事へのコメント6件

注目コメント
新着コメント

xlc テクニカルライティングってそういうことじゃないと思う。ガイドラインに従うよりいい文章をたくさん読んで、たくさん書くことが上達の近道だな。

2022/05/12 リンク

kzm1760 確かに読みやすい文章だ。脳内変換をしなくても読める文章なので、頭に入りやすい。こういう文章はある程度流しながら読んでも、頭に残っているので好き。

2022/05/13 リンク

k_ume75 一時期、技術ブログの編集長・執筆をしてたけど、これができる人ほんとうに少ない。漢字をひらくだけでぐっと読みやすくなるのに、なぜか難しい漢字使いたがるのよな。 ●文章 ●エンジニア

2022/05/12 リンク

knitcapmann 共感する。

2022/05/12 リンク

morimarii これは単に可読性の高い文章の書き方でテクニカルライティングとは違うのでは？

2022/05/12 リンク

xlc テクニカルライティングってそういうことじゃないと思う。ガイドラインに従うよりいい文章をたくさん読んで、たくさん書くことが上達の近道だな。

2022/05/12 リンク

efcl テクニカルライティング

japanese

2022/05/11 リンク

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

規約違反を報告

アプリのスクリーンショット

いまの話題をアプリでチェック！

バナー広告なし
ミュート機能あり
ダークモード搭載

アプリをダウンロード

関連記事

開発ドキュメントの書き方！9つのコツ【エンジニア】

文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決す... 文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決するのかを企画することが大切です。また、それを元にアウトラインを書いておきます。このふたつを元に文章を書くことで、読みやすい開発ドキュメントにつながります。これについては、次の記事をご覧ください。開発ドキュメントを書く前に決めるべき3つのこと︻企画編︼開発ドキュメントにおけるアウトラインの書き方開発ドキュメントの書き方企画とアウトラインの作成が終わったら、実際に文章を書いていきます。文章を書くときは、次の9つを意識して書きます。これだけで、読みやすさ、分かりやすさが大きく向上します。一文を短く切る結論を先に述べる指示語を使わない主語を明確にする、述語との距離を近づけるひらく・閉じるを統一する再現条件を示す前提を揃える見出しや箇条書き、表などを適切に用いる読者に伝わる用語を使うひとつずつ説明し

ブックマークしたユーザー

techtech05212024/05/15
longyang2023/06/15
boscoworks2022/09/14
yamashiro01102022/06/24
kwy2022/06/08
reboot_in2022/06/04
catcoswavist2022/06/02
zyun11092022/05/25
keisys2022/05/19
hotmilkcocoa2022/05/18
kamijuujou2022/05/15
skypenguins2022/05/14
jinlingren2022/05/14
dhrname2022/05/13
masayuki-as2022/05/13
paulownia2022/05/13
miguchi2022/05/13
nnakayama2022/05/13

同じサイトの新着

同じサイトの新着をもっと読む

いま人気の記事

いま人気の記事をもっと読む

いま人気の記事 - テクノロジー

いま人気の記事 - テクノロジーをもっと読む

新着記事 - テクノロジー

新着記事 - テクノロジーをもっと読む

設定を変更しましたx