コードを書くのは簡単ですが、ドキュメントを書くREADME.mdhttps://t.co/Bkh3Cq9AME) に直面してどこから始めればいいのかわからなくなったり、ドキュメントが難解で理解しにくく、誰も読みたがらなかったりします。 GitHubで偶然、このリソースコレクション「Awesome Technical Writing」を見つけました。テクニカルライティングに関連するツール、チュートリアル、キャリア開発パスが体系的にまとめられています。 GoogleやMicrosoftといった大手企業の標準スタイルガイドラインが含まれており、用語や書式の標準化に役立ちます。また、コンテンツプランニング、情報アーキテクチャ、ドキュメントの公開に至るまで、包括的なワークフローリソースも網羅しています。 GitHub: https://t.co/aSVRmWH7Ta 彼らは、Google Season of Docs などのオープンソースのドキュメント貢献プログラムのリストや、静的サイト ジェネレーターや構文チェッカーなどの補助ツールのリストも作成しました。 プロジェクト ドキュメントの最適化を検討している開発者であっても、フルタイムのテクニカル ライティングに移行する予定であっても、このリストは将来の参照用に保存しておく価値があります。
