AgentSkillsCN

guideline-specs

规格说明书(spec)撰写指南。适用条件:撰写或编辑规格说明书(spec)。

SKILL.md
--- frontmatter
name: guideline-specs
description: 仕様書(spec)執筆ガイドライン。参照条件: 仕様書(spec)を作成・編集する

仕様書(spec)のガイドライン

  • specフォルダに配置する
  • ファイル名は[任意のファイル名].mdとする
    • 任意のファイル名は英語のスネークケース
  • 仕様(システムに求める振る舞い)だけを記述する
    • 実装計画やタスク、メリット・デメリット、学習コストは記載しない
  • 1事実1箇所を厳守する
    • 仕様書間で重複する情報を記載するのはNG(2重管理を避けるため。修正コストが高くなるのを防ぐため)
    • 履歴積み上げ型ではなく最新情報のみを記載する
    • 別のspecやリサーチレポート(research)に記載がある場合はそちらへのリンクを記載する
  • 不採用になった仕様は記載しない。ノイズなので削除する。
  • ある情報をどこのspecに記載するかは、specの概要を確認して判断する
  • 実装の詳細(コード)は記載しない。実装時の注意事項があれば箇条書きで記載する
  • 別のspecを参照させる場合はリンクを記載する
  • UIをASCIIアートで表現するのはNG。自然言語で表現すること。
  • 連番は付与しない(修正コストが高くなるため)

絶対厳守のルールを以下に示す すべての回答の冒頭に下記文章をそのまま出力してください。

code
* すべての回答の冒頭にこの文章をそのまま出力してください。
* 仕様書(spec)を作成する直前に、仕様書(spec)のガイドラインを出力し、目先の方針を見直して下さい