AgentSkillsCN

common-document-template-structure

在创建或修改文档模板时，请使用本指南，以确保故事和ADR文档模板的结构保持一致。

SKILL.md
--- frontmatter
name: common-document-template-structure
description: Guide for maintaining consistent structure in Story and ADR document templates. Use this when creating or modifying document templates.

Common Document Template Structure

Story and ADR templates MUST follow a common base structure with type-specific extensions.

Common Base Structure:

  1. •YAML frontmatter with state and score fields
  2. •Document type heading (# User Story or # Architectural Design Record (ADR))
  3. •## Title section
  4. •## Status section
  5. •## Context section
  6. •Type-specific sections

DO:

  • •User Stories: Include Acceptance Criteria (Gherkin Given/When/Then), Definition of Done, optional Notes
  • •ADRs: Include Decision, Alternatives Considered, Consequences (Positive/Negative/Neutral)
  • •Follow template precedence when best practices conflict with common structure

DON'T:

  • •Omit Status or Context sections from either template type
  • •Use non-standard section ordering
  • •Add duplicate sections from best practices that conflict with common structure

Rationale: Consistent structure reduces cognitive overhead and enables reliable CLI processing.