Enforce synchronized project documentation updates alongside code changes.
npx skills add https://github.com/popo0407/AIHelper --skill documentation-popo0407
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/popo0407/AIHelper/tree/main/.github/skills/docs Command: npx skills add https://github.com/popo0407/AIHelper --skill documentation-popo0407
This Skill ensures your project documentation stays up-to-date with code changes, preventing outdated information and aiding in clear decision-making.
Ensure all documentation is updated to reflect the latest code changes.
High-intent search queries and answers about installing and using this skill.
To keep documentation synchronized with code changes, developers are prompted to update README files, API specifications, and environment variable examples alongside their code commits to prevent documentation drift.
Logging architectural decisions is best achieved by creating a dedicated decision log that records why specific architectural changes were made, which improves knowledge sharing and clear decision-making within development teams.
Maintaining API specifications when adding an endpoint requires updating the specification document and the README before committing code, ensuring project documentation stays up-to-date with the latest API changes.
Code commenting best practices encourage writing comments that explain the "why" over the "what" of the code, which facilitates effective knowledge sharing and prevents outdated information within development teams.
Updating environment variable examples like .env.example alongside code changes prevents documentation drift by ensuring configuration instructions reflect the current environment requirements of the project.
pradeepmouliExecute a script to generate baseline-spec.md and current-state.md from JSON output.
PaneriVatsalGenerate developer-facing documentation from repository structure and source files.
brendadeeznuts1111Automate linting, type-checking, tests, and commit message generation before commits.
nashgaoGenerate READMEs, API references, and getting started guides for projects.
