Skills documentation-generation-doc-generate
📦

documentation-generation-doc-generate

Content revision r2 Safe ⚙️ External commands🌐 Network access📁 Filesystem access🔑 Env variables

Generate Maintainable Documentation from Code

Outdated and inconsistent documentation slows development and creates support gaps. This skill turns code and configuration into structured documentation with validation and automation guidance.

Supports: Claude Codex Code(CC)
🥉 79 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request
Review the Skillstore skill "documentation-generation-doc-generate" from https://skillstore.io/skills/sickn33-documentation-generation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-generation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Your Agent should still show its plan and request any confirmation required by the security policy.

Agent-readable resources

Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.

Markdown detail GET /skills/sickn33-documentation-generation-doc-generate.md Signed manifest GET /api/skills/sickn33-documentation-generation-doc-generate/manifest Signed lockfile GET /api/skills/sickn33-documentation-generation-doc-generate/lockfile

Test it

Using "documentation-generation-doc-generate". Document the user service for engineers joining the team.

Expected outcome:

  • A service overview covering purpose, dependencies, and data ownership.
  • An endpoint reference organized by workflow and authentication requirements.
  • A setup guide with configuration placeholders and clearly labeled assumptions.
  • A Mermaid diagram showing requests, service dependencies, and storage.

Using "documentation-generation-doc-generate". Create a plan for keeping API documentation current.

Expected outcome:

  • Generate the API specification from route and schema definitions during continuous integration.
  • Validate breaking changes and broken links before merging.
  • Assign documentation ownership and publish versioned artifacts after successful checks.

Using "documentation-generation-doc-generate". Improve documentation coverage for a Python package.

Expected outcome:

A coverage report identifies undocumented public modules, classes, and functions, then prioritizes additions by user impact and maintenance risk.

Security Audit

Safe
v5 • 7/23/2026 Open versioned report

All 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.

2
Files scanned
698
Lines analyzed
0
Review items
0
False positives ignored

Risk Factors

⚙️ External commands (9)
resources/implementation-playbook.md:253-254 resources/implementation-playbook.md:254-255 resources/implementation-playbook.md:255-256 resources/implementation-playbook.md:256-259 resources/implementation-playbook.md:355-356 resources/implementation-playbook.md:356-357 resources/implementation-playbook.md:357-363 SKILL.md:37 SKILL.md:51
🌐 Network access (8)
resources/implementation-playbook.md:509 resources/implementation-playbook.md:503 resources/implementation-playbook.md:138 resources/implementation-playbook.md:469 resources/implementation-playbook.md:474 resources/implementation-playbook.md:500 resources/implementation-playbook.md:509 resources/implementation-playbook.md:520
📁 Filesystem access (1)
resources/implementation-playbook.md:589
🔑 Env variables (7)
resources/implementation-playbook.md:568 resources/implementation-playbook.md:319 resources/implementation-playbook.md:320 resources/implementation-playbook.md:321 resources/implementation-playbook.md:501 resources/implementation-playbook.md:511 resources/implementation-playbook.md:521
No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.
Audited by: codex View Audit History →
Share & cite this report

Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.

Open versioned report
Security Assessment

Copy report link

https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg)](https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-generation-doc-generate.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
Academic citations (APA · BibTeX · CFF)

APA citation

sickn33. (2026). documentation-generation-doc-generate security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5

BibTeX citation

@techreport{sickn33-sickn33-documentation-generation-doc-generate-2026, author = {sickn33}, title = {documentation-generation-doc-generate security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "documentation-generation-doc-generate security audit report (audit version 5)" version: "unspecified" type: report authors: - name: "sickn33" date-released: "2026-07-23" url: "https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5" identifiers: - type: other value: "skillstore:sickn33-documentation-generation-doc-generate:audit:5" description: "Skillstore immutable audit report identifier"

Skillstore Score

Why this score Evidence Confidence: High
55
Architecture
85
Maintainability
87
Content
69
Community
91
Spec Compliance

What You Can Build

Document a Service API

Create endpoint references, authentication notes, request examples, and an OpenAPI outline from service code.

Explain System Architecture

Turn components, dependencies, and data flows into maintainable diagrams and concise architecture notes.

Standardize Repository Guides

Produce consistent setup, contribution, configuration, and troubleshooting guidance across project repositories.

Try These Prompts

Create a README 
Review this repository and create a README for new developers. Include prerequisites, setup, configuration, basic usage, testing, and known gaps.
Generate API Documentation 
Analyze the API routes and schemas in [paths]. Draft endpoint documentation with authentication, parameters, responses, errors, and representative usage examples.
Map the Architecture 
Analyze the services and configuration in [paths]. Create a Mermaid architecture diagram and explain component responsibilities, dependencies, data flows, and reliability assumptions.
Design a Documentation Pipeline 
Audit documentation across this repository. Propose source-linked generation, linting, coverage checks, CI validation, publishing, ownership, and controls that prevent sensitive data exposure.

Best Practices

  • Define the audience, documentation type, and source of truth before generating content.
  • Verify generated claims against code, tests, configuration, and current deployment behavior.
  • Use placeholders for credentials and review output for secrets, internal URLs, and sensitive data.

Avoid

  • Do not publish generated documentation without technical review.
  • Do not infer endpoints, configuration defaults, or guarantees that the source does not support.
  • Do not copy secrets, private hostnames, customer data, or production values into documentation.

Frequently Asked Questions

What documentation can this skill generate?
It can draft API references, architecture diagrams, README files, user guides, developer guides, docstrings, and configuration references.
Does it modify source code automatically?
It can propose documentation files and inline comments, but changes should follow the permissions and scope provided in the request.
Can it create OpenAPI documentation?
Yes. It can extract route and schema details and draft an OpenAPI specification for technical review.
How does it handle sensitive information?
It instructs the agent to avoid secrets, internal URLs, and sensitive data. Users should still review every generated artifact before publishing.
Can it keep documentation synchronized with code?
It can design CI checks, generation steps, linting, and coverage validation. Repository-specific tooling and permissions remain necessary.
What inputs produce the best results?
Provide current source paths, target audiences, required document types, existing conventions, and clear acceptance criteria.

Developer Details

Author

sickn33

License

MIT

Skillstore revision

r2

Version notice

The author did not declare a version.

Repository

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-generation-doc-generate

Ref

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

Maintenance freshness

7/26/2026

Usage

10 downloads · 108 views

File structure

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md

More from sickn33

View all

Related Skills

View all