コンテンツにスキップ

文体・トーン規約(公開ドキュメント)

本プロジェクトの公開ドキュメントは、企業の品質保証部門やプロセス監査部門がそのまま読める水準の記述を維持します。このページは全執筆者(人・AI)共通の文体規約です。検査は npm run lint:tone で自動実行します。

  • 読者が参照できない資料や、プロジェクト内部の経緯に依存する記述をしない
  • プロセス標準(フェーズ4)の本文は、要求事項を規定する文体で書く
  • 設計思想・検討経緯は、本文ではなく附属書または research/ に置く
分類 例 望ましい書き方
内部資料への言及 音声メモ、元ネタ、議事録によれば、例の資料 本サイト内のページへのリンク、または出典URL
主観的な強調 めっちゃ、ぶっちゃけ、ヤバい、すごく 定量表現、または中立な語
断定を避ける口語 〜な感じ、〜だと思います、たぶん 断定する、または条件を明示する
未完成の痕跡 TODO、後で書く、仮置き、書きかけ 完成させる、または該当箇所を削除する
Terminal window
npm run lint:tone # トーン検査のみ
npm run check # textlint + トーン検査 + データ検証 + ビルド

検査の対象と除外は次のとおりです。

  • 対象: src/content/docs/ 配下の Markdown および MDX
  • 除外: コードブロック(``` で囲まれた範囲)と HTML コメント
  • 除外: 行末に <!-- tone-ok: 理由 --> を付けた行

引用として禁止語を使う場合(例: 差し戻し理由の悪い例として「なんとなく不安」を挙げる場合)は、tone-ok の注記で理由を明示して除外します。理由のない除外は認めません。

禁止語の一覧は scripts/check-tone.mjs の RULES にあります。追加・削除する場合は、分類・正規表現・言い換えの指針(hint)の3点を揃えて記述してください。

誤検出が続く語は、除外するか tone-ok での個別許可へ切り替えます。検査が信頼されなくなると、規約そのものが機能しなくなるためです。

プロセス標準の本文には、次の規約が加わります(第1章 1.7 に規定)。

  • 要求事項は「〜を規定する」「〜しなければならない」「〜してはならない」の形式で記述し、推奨事項と区別する
  • 設計思想・検討経緯・比較検討は附属書へ記載する
  • AI の能力に関する記述には、その記述が妥当な時点(YYYY-MM-DD)を併記する