Generate README files, API docs, code comments, and Architecture Decision Records.
npx skills add https://github.com/PVPha/agent_skills --skill documentation-pvpha
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/PVPha/agent_skills/tree/main/skills/documentation Command: npx skills add https://github.com/PVPha/agent_skills --skill documentation-pvpha
This Skill addresses the challenge of creating comprehensive and maintainable documentation for software projects, ensuring clarity for developers and users alike.
Use the documentation skill to generate a README file for a new project.
High-intent search queries and answers about installing and using this skill.
To generate API documentation, use this Skill to apply templates and best practices for documenting endpoints, request/response formats, and error codes. It ensures your API specifications remain comprehensive and accessible across multiple formats.
To document architecture decision records, this Skill facilitates the creation of ADRs to capture significant design choices. It ensures your software engineering team maintains clear records of architectural context and project rationale.
The best way to write effective code comments is to focus on explaining the 'why' behind the code. This Skill provides guidance on writing inline comments that adhere to software engineering best practices across multiple languages.
Yes, you can use this tool to update existing developer guides and API docs. When you complete a new feature, it helps generate README sections, update API specifications, and add necessary code comments to maintain project information.
everrunsAnalyze and transform code patterns using the ast-grep engine.
WebWakaHubTransform complex engineering information into clear developer documentation.
PaloAltoNetworksAutomate pull request creation, CI monitoring, SonarCloud checks, and merging.
OneWave-AIGenerate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.
