テクニカルライター
2021/3/12 21:24:00
あれ
2022/6/19 18:17:00
テクニカルライター技術文書これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけ / Two things to keep in mind about writing to make everyone happy文章の書き方目的語主語書き方技術文書の書き方
「主語や目的語を明確にしましょう」
2021/8/26 5:47:00
開発とドキュメンテーションの分離
2020/9/15 22:55:00
ドキュメンテーションを引き受ける作業者がいれば、開発者は開発に集中できる
技術的なドキュメント化はあらゆるプロジェクトに求められる汚れ仕事である。 適切なドキュメントを書いて、保守することは、プロジェクトチームが後で使ううえで重要だ。しかし、こうしたドキュメントは誰が書くというのだろう？ 開発者が自分でドキュメントを書いたら、「実際の」作業の妨げになってしまう。
それゆえ:
必要なドメインをよく知っていて、設計自体には利害関係のないテクニカルライターを雇おう。 適切な記法を用いて設計を表現してもらおう。整えたうえで公開し、レビューしたり、組織で使えるようにしてもらおう。
from 『組織パターン』