マガジンのカバー画像

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

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

#ドキュメント

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
15

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

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

Koushi Kagawa
1年前
4

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

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

Koushi Kagawa
1年前
3

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

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

Koushi Kagawa
1年前
6

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

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

Koushi Kagawa
1年前
3

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

最近は仕事でドキュメント書きまくっていると伝えたら、友人におすすめされまして「できる研究者の論文生産術」を読みました。 誰におすすめか?こんな方におすすめの本です。 技術ドキュメントを書きたい! 書いているけど、なぜか最後まで書ききれずWIPばっかり! 納得のいく文章が書けない! 書きたいけどそもそもスケジュールがない! 上記の悩みは皆さんお持ちだと思うので。皆さんにおすすめです。 私は文章を書くには下記2つが必要だと思っています。 文章の書き方を学ぶこと

ドキュメントサイトもプロダクトの一部だと気づいた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