技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
ドキュメント作成に役立つ「日本語スタイルガイド」の紹介：CodeZine
はじめに 大量のドキュメントの執筆作業を複数のメンバーで行うとき、各メンバーの文章表現にどうしても差が出ます。特に、直接ユーザーの目にとまるマニュアルなどは、用語、表現を統一することがとても重要です。 大量の翻訳マニュアルを作成するSun、Microsoftでは、翻訳作業の指針とする『日本語スタイルガイド』を公開しています。本稿では、それぞれの『日本語スタイルガイド』関連情報を紹介します（ガイドラインの内容はそれぞれをダウンロードしてご覧ください）。Sunの日本語翻訳ガイドライン Sunの翻訳ガイドラインについてまとめたページがあります。Sunの日本語翻訳ガイドライン スタイルガイドをダウンロードできます。スタイルガイドのダウンロード（PDF形式） スタイルガイドは100ページにおよびますが、4ページにまとめたクイックリファレンスを、翻訳プロジェクトのReiko Saitoさんのブログ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
