nDiki : Naney ドキュメンテーションガイドライン

文章

• 読点は「、」。
• 句点は「。」。
• 並列や同格の語の区切りには「・(中黒 / 中点)」を使う。[日][文]
• 括弧で囲まれた文が文末に来る場合、句点は括弧の外に打つ。[文]
• 見出しの最後には句点を打たない。[文]
• 箇条書きの文の文末には句点を打つ。ただし文が1文で短い時(特に名詞のみだったり体言止めだった時)は、句点を省略しても良い。一つの箇条書きの中では句点の有無を統一する。[文][W]

文章 (マニュアル)

• 文体は「ですます調」で書く。[文]
• 人が行う動作は能動態で書く。[文]
• 機械・コンピュータによって行われる動作は受動態で書く。[文]

図表

• 図表には番号をつける。
• 本文中で参照する場合は、図表番号も示す。

操作説明

アウトライン

• 操作の順番に章節を並べる。
  • インタフェースの順(ボタン順・メニュー順)にしない。そのような説明はリファレンスマニュアルに書く。

見出し (操作説明)

• 操作説明の章節の見出しは「○○する」とする。動詞の終止形で終える。
  • ex: ○「ソフトウェアをインストールする」
  • ex: ×「ソフトウェアのインスール」「ソフトウェアをインスール」

コンピュータ系文書

• ドメイン名やドメイン名を含む URI の例示では、RFC2606 で予約されているドメイン名を使う。

参考文献

• [日] 日本語の作文技術
• [文] テクニカルコミュニケーション研究会編、文章・用字用語ハンドブック、日経BP出版センター
• [W] Wikipedia:表記ガイド

関連情報

• ドキュメンテーションガイドライン
• 表記
• 用字用語
  • Naney の用字用語