マガジンのカバー画像

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

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

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

3級 テクニカルライティング試験を受験しました。概要/学習について/感想などをまと…

2023年の夏に、3級 テクニカルライティング試験[TW]を受験し、無事に合格しました。試験後、手…

Koushi Kagawa
9か月前
16

『エンジニアのためのドキュメントライティング』を読んだ感想メモ

Alphabetのテクニカルライター、Stripeのテクニカルライターなど、開発者向けドキュメント作成…

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
15

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

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

Koushi Kagawa
1年前
4

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

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

Koushi Kagawa
1年前
23

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

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

Koushi Kagawa
1年前
7

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

ドキュメントサイトを運用するにあたり、必要になるのがガイドラインです。 ガイドラインとは何か​ガイドラインとは、ドキュメント作成のための手助けとなるガイドブックのことです。 主に、ドキュメント作成において適切なフォーマットやスタイル、書き方などを指導するための方針やルールが記載されます。 ガイドラインがあることで、文書作成において適切なフォーマットやスタイル、書き方などの指針を立てることができます。 ガイドラインの必要性​ガイドラインを用意することで、以下のことに役に立

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

先日知人と話しているときに、「結局どんなドキュメントが一番良いのか?」と言う質問を受けま…

Koushi Kagawa
1年前
42

テクニカルライターになるために、参考にした、書籍と資料を紹介します。

2021年よりテクニカルライティングを学んでいます。 最初は何をすべきかが分からずに、本を読…

Koushi Kagawa
1年前
71