aps-documentation
Comprehensive skill for working with Agile Protocol Specification documentation.Automatically activates when creating, editing, or reviewing APS content.Provides templates, naming conventions, and document lifecycle guidance.
When & Why to Use This Skill
This Claude skill streamlines the creation and management of Agile Protocol Specification (APS) documentation. It ensures structural consistency and compliance by enforcing metadata-rich naming conventions, providing standardized Markdown templates for chapters, and managing the document lifecycle from draft to final state. It is an essential tool for technical writers and engineers to maintain high-quality, searchable, and professional documentation within the APS framework.
Use Cases
- Standardizing file names using the metadata-rich pattern (Type_Version_State_Date_Author) to ensure project organization and easy version tracking.
- Generating new documentation chapters using pre-defined Markdown templates to maintain structural consistency across the entire specification guide.
- Managing the document lifecycle by transitioning content through states like Draft, Provisional, and Accepted during formal review processes.
- Creating YAML context files for new modules to define metadata, dependencies, and technologies used in the APS system for better documentation indexing.
- Reviewing existing APS content for compliance with naming conventions and structural best practices.
| name | aps-documentation |
|---|---|
| description | | |
APS Documentation Skill
This skill provides comprehensive guidance for working with the Agile Protocol Specification documentation system.
When This Skill Activates
- Creating new documentation chapters or sections
- Editing existing APS content
- Reviewing documents for compliance
- Managing document lifecycle transitions
- Working with metadata-rich filenames
Key Concepts
Document States
Mutable States (open to changes):
- Draft: Initial creation, open for major edits
- Provisional: Temporary acceptance, awaiting full review
- In Review: Under formal review process
Immutable States (locked):
- Accepted: Approved by stakeholders
- Final: Officially complete, archived
Metadata-Rich Naming
Pattern: {Type}_{Version}_{State}_{Date}_{Author}.ext
Examples:
requirements_v1.0.0_draft_2024-03-22_SC.mdarchitecture_v2.1.0_accepted_2024-04-15_Team.md
Templates
New Chapter
# [Chapter Title]
[Introduction explaining purpose]
## [Main Section]
[Content]
## Conclusion
[Key takeaways]
---
Context File
---
module-name: [Name]
version: 1.0.0
description: |
[Purpose and content description]
related-modules:
- name: [Related]
path: ./path/to/module.md
technologies:
- Markdown
- mdBook
conventions:
- Follow APS naming conventions
- Include metadata headers
---
Best Practices
- Structure First: Plan document hierarchy before writing
- Clear Headings: Use descriptive section titles
- Cross-Reference: Link related content
- Context Files: Create for new modules
- Update SUMMARY.md: Add new chapters to navigation
- Build Test: Run
mdbook buildto verify
Resources
- Main SUMMARY:
specification-guide/src/SUMMARY.md - Glossary:
specification-guide/src/appendices/glossary.md - Templates:
specification-guide/src/appendices/templates_examples.md