Open5
「エンジニアのためのドキュメントライティング」を読んでプロダクトを必要とするユーザーにもっと使ってもらう
seachicken目的
自作した静的チェックツールが初回リリースから半年経ったが利用者がまだまだ少ないので、「エンジニアのためのドキュメントライティング」から学んだことを生かして、このツールを必要としているユーザーへ届けられるようにする。
読み手の理解
ユーザーのゴール
開発者及びレビュアーが Pull Request を出した時点で想定外の問題に気づくことができる。
ユーザーニーズのアウトライン
- このプロダクトで何が解決できる？
- どんな機能がある？
- 簡単に性能を試したい
- コードの漏洩などセキュリティに課題はないか？
ユーザーペルソナ
A
- 名前: アイリス
- 開発スキル: 上級
- 言語: TypeScript, Java, Kotlin
- 開発環境: MacOS, Linux
- 役割: リード開発者
B
- 名前: ケヴィン
- 開発スキル: 初級から中級
- 言語: TypeScript
- 開発環境: MacOS, Linux
- 役割: 初級開発者
ドキュメントの計画
seachicken2023/4/1時点
- star: 2
- ドキュメント:
- 簡単な README
- DEV で紹介
seachickenドキュメントを書かないとなーと思いつつ実装が楽しくて後回しになる負のループ
seachicken仕組みについて発信
seachicken英語版も発信
下記の流れで書いてみた
- とても雑な英文を書く（英文を想像する練習）
- Chat GPT 3 に読みやすくしてほしいってお願いする（まだ課金してないので 3）
- Grammaly で更に修正する（もはやこの時点でどこまで読みやすいかは分からないけど少し変更する）