Does it support adding code examples?

Absolutely. One of its primary functions is creating copy-pasteable usage examples for READMEs and API references based on how the code actually works.

What types of documentation can this skill update?

The skill is designed to update project READMEs, API documentation, inline code comments, and high-level architecture documents based on the latest code changes.

How does the skill know what has changed in the code?

It uses git diff commands to identify modified files and analyzes the implementation of new features to determine if they affect public APIs or user configurations.

Can it integrate with my existing documentation build tools?

Yes, it includes verification steps that can trigger your local build commands, such as 'npm run docs:build', to ensure the generated documentation is valid.

SDLC Documentation Manager

Name: SDLC Documentation Manager
Author: jmylchreest

byjmylchreest

•

Learning & Documentation

Synchronizes project documentation with code implementation to ensure accuracy across READMEs, API references, and inline comments.

The Documentation Skill is a specialized tool within the Aide orchestration framework designed for the final stage of the software development lifecycle. It automates the critical task of updating documentation after a feature has been implemented and verified, ensuring that README files, API specifications, and architecture diagrams accurately reflect the actual codebase. By analyzing git diffs and implementation details, it identifies necessary updates, generates clear usage examples, and maintains consistency across the project's documentation suite, helping teams avoid 'documentation rot'.

Key Features

014 GitHub stars

02Intelligent inline commenting for complex algorithms and non-obvious design decisions.

03Architecture documentation synchronization reflecting structural changes and data flows.

04Automated README updates for installation, configuration, and new usage instructions.

05API documentation generation including function signatures, parameters, and return types.

06Integrated verification steps to run documentation builds and check for broken links.

Use Cases

01Updating project READMEs immediately after adding new CLI flags or configuration options.

02Refining architecture docs and inline comments following a significant code refactor.

03Generating comprehensive API documentation for newly implemented public interfaces and functions.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jmylchreest/aide docs

For use in Claude.ai and ChatGPT

Download Skill