マガジンのカバー画像

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

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

#ライティング

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

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

Koushi Kagawa
1年前
15

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
23

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

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

Koushi Kagawa
1年前
7

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
42

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

2021年よりテクニカルライティングを学んでいます。 最初は何をすべきかが分からずに、本を読み、動画を見て、ひたすら書くというのを続けていました。まだまだ勉強中ではありますが、徐々にコツを理解してきて何とか続けて来れてます。 そんな中で、ライティングに興味を持つ方から「どんな勉強すると良いです?」や、「どんな本がオススメ?」と質問されることが増えてきました。良い機会なので、今まで学習してきた中で、良かった内容をまとめてみようと思います。 これからテクニカルライティング学ん

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

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

Koushi Kagawa
2年前
5

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

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

Koushi Kagawa
2年前
8

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

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

Koushi Kagawa
2年前
10

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

普段プロジェクトの課題管理はGitHub運用してて、何かあればなんでもissueに書いてもらうよう…

Koushi Kagawa
2年前
30

ライターじゃなくても知っておきたい、文章作成の基本テクニック

昨年の12月からKurocoドキュメントサイトのPjMを務めると同時に、文章を書く時にどの点に気を…

Koushi Kagawa
2年前
7