skills.rest
raultorres2603
raultorres2603COMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation

Generate documentation from mined codebase data with automated security screening and phased workflow.

Updated Feb 2, 2026
Search Tags:#automation#workflow#documentation#codebase#readme#security-scan
One-click install
npx skills add https://github.com/raultorres2603/ComplAI --skill documentation-raultorres2603
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/raultorres2603/ComplAI/tree/main/.opencode/skills/documentation
Command: npx skills add https://github.com/raultorres2603/ComplAI --skill documentation-raultorres2603

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produce or update README.md (or another specified doc file). Every fact comes from the codebase — nothing is invented. Security — non-negotiable: Documentation is public. Never include secrets, credentials, API keys, tokens, private URLs, internal IPs, account IDs, or private ARNs. Reference environment variable names only. When in doubt, omit.

Core Features & Use Cases

  • Automatically generate or refresh documentation by extracting data from the codebase (readme, architecture diagrams, API references, infrastructure docs).
  • Enforce security and privacy: never include secrets; run a security scan before saving.
  • Follow a phase-driven workflow (Scope assessment, Reference gathering, Documentation writing, Validation, Saving) to ensure accuracy and repeatability.

Quick Start

Run the Documentation Skill to generate or update the project's documentation from the current codebase.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate documentation directly from my codebase?▼

Run a security scan on your codebase before generating documentation to ensure no secrets, credentials, API keys, tokens, private URLs, or internal IPs are included. Reference environment variable names only and omit anything uncertain.

Can I update a README and architecture docs partially or do I need a full refresh?▼

You can update a README, architecture, API references, and infrastructure docs using either FULL or PARTIAL scopes. The workflow derives every fact directly from the codebase to maintain accuracy across whichever scope you choose.

How does a phase-driven workflow keep codebase documentation accurate?▼

A phase-driven workflow keeps documentation accurate by sequentially executing scope assessment, reference gathering, documentation writing, validation, and saving. Each phase derives facts strictly from the codebase, ensuring repeatable and verified outputs.

What is the best way to ensure no secrets leak into public README files?▼

The best way to prevent secrets in public README files is enforcing a security scan before saving. Never include credentials, API keys, tokens, private URLs, internal IPs, account IDs, or private ARNs; reference environment variable names only.

Do I need any external dependencies to automate README generation from source code?▼

Run a security scan on your codebase before generating documentation to ensure no secrets, credentials, API keys, tokens, private URLs, or internal IPs are included. Reference environment variable names only and omit anything uncertain.

Related Skills

Explore More Content & Communication Skills→
coakenfoldcoakenfold

technical-writer

Generate Markdown documentation from source code and API references.

Community
Intermediate
dthuy62dthuy62

ck:docs

Analyze codebases to initialize, update, and summarize project documentation.

Community
Advanced
HabitaNexusHabitaNexus
1

Container Security

Scan, sign, and monitor container images across Kubernetes clusters.

Official
Advanced
Ryno-Crypto-Mining-ServicesRyno-Crypto-Mining-Services

scribe-role-skill

Generate and maintain project documentation for codebases, APIs, and deployment processes.

Official
Advanced