Generate structured documentation for RIC projects, including READMEs, runbooks, and API docs.
npx skills add https://github.com/lichong-a/ric-skills --skill ric-docs
Please help me install this Agent Skill. Skill: ric-docs Source: https://github.com/lichong-a/ric-skills/tree/main/skills/ric-docs Command: npx skills add https://github.com/lichong-a/ric-skills --skill ric-docs
This Skill addresses the challenge of maintaining comprehensive and accurate documentation for RIC projects, ensuring that all necessary information is readily available for future reference and handoff.
Run the ric-docs skill to generate a comprehensive documentation set for your project.
High-intent search queries and answers about installing and using this skill.
To generate structured project documentation for RIC applications, use this Skill to automatically produce README files, setup guides, API docs, admin console references, and runbooks. It provides a comprehensive framework covering project purpose, tech stack, prerequisites, and deployment notes for engineers.
Runbooks for RIC project operations should include specific symptoms, diagnostic checks, command-line instructions, and detailed remediation steps. This Skill provides guidelines to create these operational runbooks, ensuring engineers and operators have precise procedures for troubleshooting.
To document API endpoints and admin console workflows for software handoff, this Skill structures API docs with authentication, request/response details, and examples. It also documents admin system roles, menu structures, workflows, and audit behavior for comprehensive operational reference.
Yes, this documentation framework works for projects without external dependencies, as it operates standalone to generate project references. It is designed for engineers and operators to streamline RIC project documentation creation without requiring additional external modules or libraries.
The best way to maintain accurate changelogs during project updates is to use this Skill's structured guidelines, which help you record concise and informative entries. This ensures all necessary project information remains readily available for future reference and team handoff.
keturkGenerate evidence-backed reports on specified Datrix components from source code and configurations.
SSiertsemaEvaluate documentation tooling against audience, content, and technical criteria.
I7T5Automate version bumping, CHANGELOG updates, and CI/CD execution for Edmund releases.
fabioc-alohaScaffold technical documentation projects with templates for API endpoints and guides.
