自作ソフトウェアのドキュメントを書こうと思っています。わかりやすいドキュメントを書く際に気をつけるべきこととしてはどんな物があるでしょうか？
※ 有料アンケート・ポイント付き質問機能は2023年2月28日に終了しました。
■
使い方が感覚的に理解できる具体例
nandedarou2006/07/06 05:39:03
1pt
機能の網羅的な説明の他に、
ソフトの使い方が短時間で感覚的に理解できるように
具体例を用いての説明が欲しい。
こういうのチュートリアルっていいますよね？
でも、チュートリアルって言葉自体があまりなじみがないので
言葉も分かりやすくすべき。
「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。
これ以上回答リクエストを送信することはできません。制限について
125
123
機能の網羅的な説明の他に、
ソフトの使い方が短時間で感覚的に理解できるように
具体例を用いての説明が欲しい。
こういうのチュートリアルっていいますよね？
でも、チュートリアルって言葉自体があまりなじみがないので
言葉も分かりやすくすべき。