本文へ移動

文書を独自の静的検査で管理

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

独自の静的検査の対象にした文書

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

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

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

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

  • クリップボードの上でペンを持つ手
    写真: Mohamed_hassan / Pixabay
  • 書類、紙類、文書
    写真: Tomasz_Mikolajczyk / Pixabay

この経験をお客様のプロジェクトに

「文書を独自の静的検査で管理」を、お客様の組織の似た課題を考える出発点にしてください。この実績を支えたサービスを、お客様のプロジェクトにも提供できます。 取引先、予算、設計について、知識に基づく別の見解が必要なときに、同じ側に立って判断を支えます。

サービスを見る お問い合わせ

結果の背景を確かめる

この事例の状況、判断、結果をご覧ください。どの部分がお客様の制約の下でも生かせるか、どこに別の方法が必要かをご相談いただけます。 文書を独自の静的検査で管理 — 独自の静的検査の対象にした文書

サービスを見る お問い合わせ

より多くの実績の 一つです — そのすべてをこのサイトで公開しています。

どの項目も、状況、課題、実施内容、変化という同じ構成で記載しています。

すべての実績を見る

必要な改善を定める

必要な判断、影響を受ける人々、すでに検討した選択肢をお知らせください。選択に伴う利点と不利益を明確にし、推奨案を文書に残せます。

料金を見る お問い合わせ

文書が気づかないうちに古くなっていませんか?

「文書を独自の静的検査で管理」の判断の背景についてお尋ねください。仕事内容を説明し、お客様のプロジェクトを検討できる担当者が対応します。

サービスを見る
welcome@engineer.company +45 50 10 61 84 デンマーク、コペンハーゲン
文書に、引き下げのみ可能なファイル別行数上限、目次要件、実在パス検査を設けた。完了扱いの9計画中6計画に未完了項目があり、コミットを制御する14タスクがどの文書にも記載されていないことを検出した。のQRコード
このページを持ち歩くhttps://engineer.company/ja/portfolio/put-the-documentation-under-its-own-linter/