わかりやすいドキュメントを書くには 〜 全体像を把握できることが重要 - Qiita
はじめに エンジニアなら誰でもたくさんのドキュメントを読むことになります。 その中にはわかりにくいドキュメントも少なからずあると思います。 自分はわかりにくいドキュメントは「全体像が掴みにくい」ことが多いと感じています。 そこで、ここではわかりやすいドキュメントを書くための方法を「全体像を把握できるようにする」という視点でまとめてみました。 また、最後に具体例としてQiita APIドキュメントでわかりにくい点の指摘と改善をしてみました。 ここで扱うドキュメントの種類 ここでは仕様書やリファレンスマニュアルといった類のドキュメントを想定しています。 Qiitaの投稿やブログの記事といったものでも共通する部分は多いのですが、これらには他にも重要な要素があると思うので、ここでは扱いません。 わかりにくいドキュメント=全体像が掴めないものが多い 先ず、わかりにくいドキュメントとはどんなものでしょ
Markdown文法の全訳
Markdownの文法について作者が解説したページを全訳してみました。 まだまだ手を入れ足りないところがありますが暫定公開します。 【更新】2008年12月30日17時45分(ホームページを移動) 【原文】http://daringfireball.net/projects/markdown/syntax.php 【ＨＰ】http://daringfireball.net/projects/markdown/ はじめに 注意 ライセンスは修正BSDライセンスです。原文のライセンスを尊重の上、適当にどうぞ。 意訳していて、原文の意味を損なわない程度に言葉を加えたり省略している部分があります。 訳が間違っている可能性があります。暫時修正はするつもりですが、必ず原文を優先するようにしてください。 意見等につきましては遠くない将来にコメント欄など何らかの連絡方法を保てるようにしたいと考えていま
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
