Instruction file imported from vehiclevisionjp/VehicleVision.PleasanterTools.Questionnaire (.github/instructions/ドキュメント.instructions.md). Copyright stays with the author.

ドキュメント作成時の指示

配置先

• ドキュメントは _documents/ 配下へ置くこと
• _reference/ へは何も書かないこと。 サブモジュール（Pleasanter 本体）の作業ツリーであり、 ここへの変更はコミットできない

Dealer は利用者向け（_VehicleVision.Dealer.Documents）と開発向け （_VehicleVision.Dealer.DevelopmentDocuments）を CI の発行対象で分けている。 本リポジトリはまだ発行 CI が無いため 1 か所にまとめる。 PDF/HTML 発行を始める段階で同じ 2 分割へ移行し、この節を更新すること。

文書種別とファイル名

• ファイル名と H1 の文書種別は文書の目的に応じて 「仕様書」「運用手順書」「調査結果」「一覧」「方針」「フロー」「情報」に統一すること
  • 「取扱説明書」「マニュアル」「使用ガイド」「運用手順」「実装調査」「現状調査」は 新規の文書種別名として使用しない
• ファイル名は {内容を端的に表す名前（日本語）}.md の形式にすること
  • カテゴリ分けが必要なときは {カテゴリ名（日本語）}-{内容を端的に表す名前（日本語）}.md としてもよい
  • 連番プレフィックスは付けないこと

書き方

• 図表は Mermaid で書くこと。 画像ファイル・アスキーアートを新規に持ち込まない
  • 構成図・処理フローは flowchart、順序のあるやり取りは sequenceDiagram、 状態遷移は stateDiagram-v2、日程は gantt
• コードブロックの言語指定を省略しないこと。 シェルは bash、C# は csharp、 TypeScript は ts、JSON は json、SQL は sql。 該当する言語が無い出力例・構造図などは text を指定する
• 仕様を記載する場合は、ソースコード・設定ファイル・実機の応答など 実物を根拠にすること
  • Pleasanter の仕様は _reference/Implem.Pleasanter の実ソースと実機の両方で確認する
  • 根拠にしたファイルパスと行番号、または出典 URL と参照日を残すこと
• 根拠が確認できない事項は推測で書かないこと。未確定であることを明示し、 確認が必要な点として報告すること
• 既存の記述と実物が食い違っている場合は、実物に合わせて修正し、何がどう違ったかを報告すること

検証

• Markdown の Lint は .markdownlint-cli2.jsonc の設定に従うこと