technical-writing-styleguide

Voice: first person plural ("we'll install..."), active voice, friendly and informal tone.

Brand names: many tech brand names have irregular capitalization (JavaScript not Javascript, GitHub not Github, Node.js not NodeJS). Always verify against the brand-names reference.

Numbers: spell out numbers under ten and at the start of sentences. Use numerals for 10 and above. Numbers over three digits get commas (1,000).

明確で一貫性のあるドキュメントのためのテクニカル ライティング スタイルガイド。技術コンテンツ、ガイド、チュートリアル、またはドキュメントを作成、編集、またはレビューするときに使用します。記事のレビュー、書き方、ブランド名、文法チェック、スクリーンショットのガイドライン、ガイドの監査、技術文書をトリガーします。 ソース: artivilla/agents-config。