ck:docs

Analyze codebases and generate structured documentation in the docs/ directory.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/hidonguyen/trade-ops --skill ck-docs-hidonguyen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ck:docs
Source: https://github.com/hidonguyen/trade-ops/tree/main/.opencode/skills/docs
Command: npx skills add https://github.com/hidonguyen/trade-ops --skill ck-docs-hidonguyen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill reduces the friction and time required to create, update, and summarize project documentation by automating codebase analysis, coordinating documentation agents, and enforcing size and validation checks so teams can maintain accurate docs without manual heavy lifting.

Core Features & Use Cases

  • Codebase Scouting & Analysis: Performs targeted, parallel scans for LOC and structure, skipping sensitive or irrelevant directories and integrating ck:scout for deep exploration.
  • Docs Initialization & Update Orchestration: Spawns a docs-manager agent to generate or refresh README and files under docs/ (project-overview-pdr.md, codebase-summary.md, code-standards.md, etc.) according to detected repository structure.
  • Summaries, Size Checks & Validation: Produces quick summaries, enforces file length limits after generation, and runs validation steps (for example the validate-docs script) to detect inconsistencies.
  • Use Case: Initialize documentation for a new repository to produce a baseline docs/ set, or run targeted updates after code changes to keep docs synchronized.

Quick Start

Use the ck:docs skill to analyze the repository and generate initial documentation by invoking /ck:docs init.

Frequently Asked Questions about ck:docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate project documentation for a new codebase?

Generating project documentation for a new codebase involves running an initialization command that performs parallel codebase scouting and orchestrates agents to create a structured docs/ directory with README and summary files.

What is the best way to keep repository documentation updated after code changes?

The best way to keep repository documentation updated is by running targeted update commands that spawn a docs-manager agent to refresh existing docs and enforce file size limits with post-update validation.

Can I scan multi-module web applications to create a codebase summary?

You can scan multi-module web applications to create a codebase summary by performing parallel codebase scouting that analyzes structure and lines of code while skipping sensitive directories.

Does automated documentation generation support post-update validation?

Yes, automated documentation generation supports post-update validation by running validate-docs scripts after generation to detect inconsistencies and enforce file length limits across the docs/ directory.

What files are created when initializing documentation for software repositories?

When initializing documentation for software repositories, the system creates a baseline docs/ set including project-overview-pdr.md, codebase-summary.md, code-standards.md, and a README based on the detected repository structure.

Why does codebase scouting skip certain directories during repo analysis?

Codebase scouting skips certain directories during repo analysis to avoid processing sensitive or irrelevant folders, ensuring the generated documentation focuses only on meaningful project code.