BattleScope
Streamline technical documentation for BattleScope features, maintaining consistency across API, frontend, and architecture layers.
Introduction
The Feature Documenter is an essential engineering tool for developers and architects working within the BattleScope ecosystem. It automates the creation and maintenance of technical specifications, ensuring that every new feature, API endpoint, or service enhancement is documented according to the repository's strict standards. By enforcing a unified structure across the product, feature, technical, and architecture layers, this skill prevents documentation rot and ensures that cross-referenced specs remain synchronized.
This tool is specifically designed for developers managing distributed microservices, providing templates for feature specifications, OpenAPI documentation, and frontend implementation details. It facilitates the creation of IMPLEMENTATION_SUMMARY.md files, which capture critical technical decisions, challenges encountered, and maintenance guidance for future iterations. Whether you are implementing a new service, refining an existing API, or documenting system-level observability requirements, this skill ensures your documentation remains as robust as the codebase.
-
Automatically generates standardized feature-spec.md, openapi-spec.md, and frontend-spec.md templates.
-
Maintains consistency across the docs/features/ and docs/technical-specifications/ directory structures.
-
Tracks feature status and roadmap progress to ensure transparency in development cycles.
-
Records technical debt and architectural design decisions to support long-term maintainability.
-
Ensures synchronization between documentation and implemented microservices (Ingestion, Enrichment, Battle, Search, Notification, and BFF).
-
Invoke this skill during the design phase of a new feature to scaffold the documentation requirements.
-
Use it to perform incremental updates when modifying API contracts or changing domain service boundaries.
-
Always keep the IMPLEMENTATION_SUMMARY.md updated with findings from your development process to assist team collaboration.
-
Rely on the established templates for all documentation to adhere to the V3 microservices architecture standards.
-
This skill expects inputs related to specific feature paths; ensure you provide the correct <feature-name> when initializing a new documentation set.
Repository Stats
- Stars
- 0
- Forks
- 0
- Open Issues
- 0
- Language
- HTML
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- May 4, 2026, 12:59 AM