マガジンのカバー画像

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

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

記事一覧

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

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

Koushi Kagawa
1年前
24

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
17

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

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

Koushi Kagawa
1年前
5

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
24

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

先日ドキュメントのレビューについて相談を受けました。 『レビューをしてもらう必要性はわかっているものの、いろいろツラい』とのこと。具体的に話を聞いてみると、以下のようなツラみがあるようです。 「わかるな〜」と思いつつ、「私はどうやってレビュー対応していたっけな?」というのを考えてみたいと思います。 レビューについてそもそもの話として、良いドキュメントを書くにはレビューが必要です。 他者に見てもらうことによって、足りない部分を補えたり、無駄な部分を省けてスッキリさせたりでき

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
42

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

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

Koushi Kagawa
2年前
81

「できる研究者の論文生産術」を読みました。読んだ感想など。

最近は仕事でドキュメント書きまくっていると伝えたら、友人におすすめされまして「できる研究…

Koushi Kagawa
2年前
5

ドキュメントサイトもプロダクトの一部だと気づいた1年でした。 Kurocoドキュメントチ…

こんにちは。賀川と言います。 現在はディバータ社にてヘッドレスCMS 『Kuroco(クロコ)』のド…

Koushi Kagawa
2年前
8

ドキュメントサイトにおけるSEOの考え方

こんにちは。日々ドキュメントサイトを運営し、ドキュメントを書き、ドキュメントを届けるため…

Koushi Kagawa
2年前
10

GitHubのissue、こう書かれているとめちゃくちゃ嬉しい。良いissueの書き方とは

普段プロジェクトの課題管理はGitHub運用してて、何かあればなんでもissueに書いてもらうようにしているのですが、GitHub慣れていない方や文章書くの苦手な方にとっては、 という疑問が湧いてくると思います。今回はその疑問に対する回答を書きます。 issueはどんどん書こうまず姿勢の話になりますが、issueはどんどん書きましょう。書いてダメなことはありません。少しでも「あれ?」と思ったら書きましょう。 起票者は、issueを書くことで問題点を言語化して伝えること