マガジンのカバー画像

ドキュメントデザイン Document Design

15
ドキュメントについて学ぶために、さまざまな本や記事から得た情報を紹介します。
運営しているクリエイター

#ライティングデザイン

ドキュメントの効果を計る方法について、10案ほど考えた

ドキュメントサイトを運営している中で、非常に頭を抱えているのがドキュメントの効果測定です…

Koushi Kagawa
1年前
15

ドキュメントを書くために設計書を作る

私はドキュメントを書く前に、設計書を書いて書く内容をまとめています。 設計書、開発の時に…

Koushi Kagawa
1年前
4

シンプルで効率的な、ドキュメント作成の3ステップ(ドキュメントを最後まで書き切れ…

ドキュメントについて、よく下記のような質問をいただきます。 書きたいことはあるけれども、…

Koushi Kagawa
1年前
3

textlintと音読でドキュメントをレベルアップする(ひとりレビューの方法)

先日レビューのコツについてnoteを書きました。 すると、「周りにレビューしてもらう人がいな…

Koushi Kagawa
1年前
23

レビューしてもらう/する場合に意識すること、やり方を考える

先日ドキュメントのレビューについて相談を受けました。 『レビューをしてもらう必要性はわか…

Koushi Kagawa
1年前
7

ドキュメントを作る前に、ガイドラインを作ろう

ドキュメントサイトを運用するにあたり、必要になるのがガイドラインです。 ガイドラインとは…

Koushi Kagawa
1年前
3

ドキュメント作成のコツは、正しいことをわかりやすく書くこと

先日知人と話しているときに、「結局どんなドキュメントが一番良いのか?」と言う質問を受けました。 うーむ、としばらく考えたのですが、結論としては『正しいことをわかりやすく書く』かな、と答えました。 こうして改めて文章にすると当たり前のことしか言ってないな、という感じですが。。この当たり前のことができていないのだろうな、という気持ちになりました。 せっかくなのでもう少し深掘りしてみたいと思います。 ドキュメントには4種類あるドキュメントには下記の4種類あります。 正しくてわ