ric-docs

Community

Streamline RIC project documentation with structured guidelines.

Authorlichong-a
Version1.0.0
Installs0

System Documentation

What problem does it solve?

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.

Core Features & Use Cases

  • Structured Documentation: Provides a framework for documenting project purpose, tech stack, prerequisites, and deployment notes.
  • Runbooks: Offers guidelines for creating detailed runbooks with symptoms, checks, commands, and remediation steps.
  • API Docs: Ensures API documentation includes endpoints, auth, request/response details, and examples.
  • Admin Docs: Documents admin system roles, menu structure, workflows, and audit behavior.
  • Changelog: Helps maintain concise, informative changelogs for project updates.

Quick Start

Run the ric-docs skill to generate a comprehensive documentation set for your project.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: ric-docs
Download link: https://github.com/lichong-a/ric-skills/archive/main.zip#ric-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.