このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- 万華鏡
- テクニカル ライター:
- techwriterjill
- プロジェクト名:
- Kaleidoscope のドキュメントを開発、改善する
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
私はライターとして、このプロジェクトにとても興味があります。私は現在、Kaleidoscope Model 01 のような機能のない人間工学に基づいたキーボードを使用していますが、分割型/テント型のキーボード レイアウトに慣れているため、ファームウェアの機能のテストと探索の初期段階で役立つと思います。類似製品のユーザーとしての経験から、他のユーザーにとって役立つプロダクトの機能やドキュメントを特定することもできます。
複雑な製品の設置と構成を文書化した経験があり、この種の作業を非常に楽しんでいます。また、プロダクトやプロセスについて「実践的」（このケースでは文字どおり）になじみ、詳しく書くのも好きです。これにより、ユーザーにとって本当に価値のある質の高いドキュメントを作成できると考えています。
専任のテクニカル ライターになる前は、サポート アナリストとして働いていました。この経験から、コードのコンパイル、テスト、問題の調査と再現など、このプロジェクトで役立つ貴重なスキルを身に付けました。
Kaleidoscope の Jesse と Gergely に最初の連絡をしました。承認された場合は、ユーザーにとって最も価値があると判断された次のプロジェクトに取り組むという暫定的な計画を立てました。
- ハードウェア プラグインを文書化する
- 初心者向けにマクロの作成方法を記述する
- 利用可能なプラグインの概要を記述する
私はフルタイムで働いているため、ドキュメント シーズン中は週に 10 時間ほど参加できます。これにより、上記に加えて、より多くの小規模なプロジェクトを完了できる可能性があります。Kaleidoscope について調査したところ、ユーザーにとってわかりやすい商品の説明は Kickstarter のページにのみ記載されていることがわかりました。最初のクラウドファンディング プロジェクトは 2015 年に終了したため、ユーザー重視のウェブサイトが必要だと思います。私はウェブ デベロッパーではありませんが、Kaleidoscope に関心をお持ちであれば、このウェブサイトのためのアイデアやテキストを投稿したいと思います。
Jesse と Gergely は、成功した作家にキーボードを送ろうと申し込んでおり、これはプロジェクトの成功に欠かせないものだと思います。
私のスキルと経験は、このプロジェクトに最適な候補者であると確信しております。ご連絡をお待ちしております。