ms-workflow-living-docs

Scan code for TAG blocks and generate API docs from function signatures and docstrings.

Updated Oct 16, 2025
One-click install
npx skills add https://github.com/beomeodev/specter --skill ms-workflow-living-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ms-workflow-living-docs
Source: https://github.com/beomeodev/specter/tree/main/.claude/skills/ms-workflow-living-docs
Command: npx skills add https://github.com/beomeodev/specter --skill ms-workflow-living-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Living-Docs Manager automates the creation and synchronization of project documentation by scanning code for TAG blocks, generating API docs from function signatures and docstrings, and keeping README and daily logs up to date.

Core Features & Use Cases

  • Scans code for TAG blocks (@SPEC, @TEST, @CODE, @DOC) to build a complete traceable documentation chain.
  • Generates API documentation from function signatures and docstrings and places it under docs/api.
  • Updates development daily logs with git diff summaries and syncs TAG chains, and synchronizes README status.
  • Supports parallel processing for faster large-scale doc generation and integrates with /fin and /finq workflows, using fail-open error handling to avoid blocking commits.

Quick Start

Use the Living-Docs Manager to scan your codebase, generate API docs, and synchronize project docs and daily logs.

Frequently Asked Questions about ms-workflow-living-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate living documentation synchronization with my codebase?

You can generate API docs from function signatures and docstrings by scanning source files under src/ and docs/. The tool extracts the signatures and outputs the generated documentation directly into the docs/api directory.

How do I generate API documentation from function signatures and docstrings?

You can generate API docs from function signatures and docstrings by scanning source files. The tool extracts the signatures and outputs the generated documentation directly into the docs/api directory.

Can I use TAG scanning to validate SPEC, TEST, CODE, and DOC chains?

Yes, you can use TAG scanning to validate the complete SPEC, TEST, CODE, and DOC chains across your specs, tests, and source directories. This ensures traceability and consistency throughout your project documentation.

Does the documentation sync process support parallel processing for large repositories?

The documentation sync process supports parallel processing for large repositories to accelerate doc generation. It also integrates with /fin and /finq workflows using fail-open error handling to prevent commit blocking during synchronization.

How do I update development daily logs with git diff summaries?

To update development daily logs with git diff summaries, the tool scans recent code changes and automatically syncs the TAG chains and README status. This keeps your project logs aligned with your actual codebase modifications.