Automates the creation and maintenance of viewpoint-based architecture specifications and technical user guides.
The write-spec skill provides a standardized framework for documenting complex software systems using a viewpoint-based architecture. It streamlines the documentation lifecycle by automatically gathering context from git diffs, tickets, and file structures via a dedicated Bash script. By enforcing consistency across eight specific architectural viewpoints—including stakeholder, model, and infrastructure—the skill ensures that documentation remains a 'living' reflection of the current codebase. It features robust support for internationalization (Japanese mirroring), automated frontmatter management, and integrated Mermaid diagramming to provide clear, professional documentation for both developers and end-users.
Características Principales
010 GitHub stars
02Support for eight standardized architectural viewpoints (Stakeholder, Data, Model, etc.)
03Automated frontmatter management including ISO timestamps and commit hashes
04Standardized Mermaid diagram embedding and directory structure enforcement
05Automated context gathering from git history and archived tickets
06Integrated i18n support with automated English-to-Japanese document mirroring
Casos de Uso
01Maintaining dual-language developer guides and READMEs within the .workaholic directory
02Synchronizing technical specifications with the latest code changes after a feature merge
03Generating comprehensive architectural documentation for new contributors using viewpoint-based templates
