文書を独自の静的検査で管理
文書に、引き下げのみ可能なファイル別行数上限、目次要件、実在パス検査
を設けた。完了扱いの9計画中6計画に未完了項目があり、コミットを制御す
る14タスクがどの文書にも記載されていないことを検出した。
8月 2026

状況.
品質、デザイン、アクセシビリティ、印刷、メタデータ、翻訳、gitを26文
書の指示で管理していた。指示は長くなり、コードからずれ、移動したファ
イルを参照し、一定の長さで読まれなくなる。読まれない規則は規則として
働かない。

課題. 助言でなく失敗する上限を持つ静的検査を設け、文書もコードと同じ
ように扱う必要があった。

行動.
8つの機械的な方針を設けた。文書長の絶対上限と警告する目安、縮むだけ
で戻らないファイル別行数予算、大きさに応じた全体目次・節目次、主題の
担当文書を定める配置規則、リンク妥当性、主張とチェック欄が一致する計
画の正直さ、コミットを制御する全タスクの文書記載、記したパスとコード
記号の実在検査だった。初回で、未完了欄付きの完了6計画、どこにも記載
のない14タスク、リンク切れ3件、孤立文書1件、5文書にまたがる死んだパ
ス3件を検出し、必要性を示した。その後、この仕事の説明を開発文書へ加
えると上限に達し、作成者自身を拒否して別文書が生まれた。意図どおりの
働きだった。

結果.
計約2,666実効行の26文書が、増やせない予算下に入り、全パスと記号を実
ツリーに照合するようになった。毎コミットを止める14検査が一切記載され
ていなかったという、機械の規則と人が読む規則の分離こそ、繰り返す価値
のある不都合な発見だった。

カテゴリー:
1自動化・CI/CD	/ja/categories/automation/	advisory.engineer.company	70
1テスト・品質保証	/ja/categories/testing/	advisory.engineer.company	70
1Python	/ja/categories/python/	advisory.engineer.company	70
1技術面の統率	/ja/categories/technical-leadership/	advisory.engineer.company	70
1プロジェクト管理	/ja/categories/project-management/	advisory.engineer.company	70
1文書作成	/ja/categories/documentation/	advisory.engineer.company	70

サービス:
1技術面の統率・コンサルティング	/ja/services/technical-leadership/	advisory.engineer.company	70
1プロジェクト管理（アジャイル）	/ja/services/project-management/	advisory.engineer.company	70
1技術文書の作成	/ja/services/technical-documentation/	advisory.engineer.company	70

hこのページのウェブ版	URL:https://advisory.engineer.company/ja/portfolio/put-the-documentation-under-its-own-linter/	advisory.engineer.company	70
