Skills documentation-generator
📦

documentation-generator

Content revision r1 Safe ⚙️ External commands

Generate Developer Documentation

Manual documentation updates are slow and often inconsistent with code behavior. This skill guides Claude, Codex, and Claude Code to draft docstrings, README sections, and API references from source context.

Supports: Claude Codex Code(CC)
🥉 78 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-generator" from https://skillstore.io/skills/curiouslearner-documentation-generator.md and its manifest at https://skillstore.io/api/skills/curiouslearner-documentation-generator/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/curiouslearner-documentation-generator.md Signed manifest GET /api/skills/curiouslearner-documentation-generator/manifest Signed lockfile GET /api/skills/curiouslearner-documentation-generator/lockfile

Test it

Using "documentation-generator". A TypeScript utility function with price, tax, and discount parameters.

Expected outcome:

  • A concise purpose sentence.
  • Parameter notes for base price, tax rate, and optional discount.
  • Return and error descriptions plus a small usage example.

Using "documentation-generator". A Python service class with public methods and raised exceptions.

Expected outcome:

  • A class summary that states the main responsibility.
  • Method documentation with arguments, return values, and exceptions.
  • Notes about side effects and expected caller behavior.

Using "documentation-generator". A repository that needs a first README.

Expected outcome:

  • A project overview for new users.
  • Installation, usage, configuration, API, contribution, and license sections.
  • Placeholder guidance for details the maintainer must verify.

Security Audit

Safe
v8 • 7/6/2026 Open versioned report

The flagged external command findings are false positives caused by markdown code fences and example snippets in SKILL.md, not executable shell or Ruby code. The system reconnaissance finding is also a false positive because the cited line is a documentation writing guideline. No prompt injection, exfiltration intent, or hidden execution behavior was found.

1
Files scanned
176
Lines analyzed
0
Review items
0
False positives ignored

Risk Factors

⚙️ External commands (11)
SKILL.md:48-62 SKILL.md:62-65 SKILL.md:65-84 SKILL.md:84-88 SKILL.md:88-94 SKILL.md:94-98 SKILL.md:98-111 SKILL.md:111-113 SKILL.md:113-117 SKILL.md:117-119 SKILL.md:119-134
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/curiouslearner-documentation-generator/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/curiouslearner-documentation-generator/security.svg)](https://skillstore.io/skills/curiouslearner-documentation-generator?utm_source=security_passport_badge)

HTML badge

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

Embed card

<iframe src="https://skillstore.io/embed/skills/curiouslearner-documentation-generator.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

CuriousLearner. (2026). documentation-generator security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/curiouslearner-documentation-generator/audits/8

BibTeX citation

@techreport{curiouslearner-curiouslearner-documentation-generator-2026, author = {CuriousLearner}, title = {documentation-generator security audit report (audit version 8)}, institution = {Skillstore}, year = {2026}, number = {8}, url = {https://skillstore.io/skills/curiouslearner-documentation-generator/audits/8}, 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-generator security audit report (audit version 8)" version: "unspecified" type: report authors: - name: "CuriousLearner" date-released: "2026-07-06" url: "https://skillstore.io/skills/curiouslearner-documentation-generator/audits/8" identifiers: - type: other value: "skillstore:curiouslearner-documentation-generator:audit:8" description: "Skillstore immutable audit report identifier"

Skillstore Score

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

What You Can Build

Document a Utility Module

Create consistent comments for functions, parameters, returns, exceptions, and examples before code review.

Prepare a Project README

Draft core README sections so contributors can install, use, configure, and extend the project.

Standardize API References

Convert source structure into predictable API reference sections for SDKs, services, or packages.

Try These Prompts

Add Basic Docstrings 
Review the selected functions and draft concise docstrings that explain purpose, parameters, returns, and errors. Keep the existing style.
Generate README Sections 
Use the project files I provide to draft a README with overview, installation, usage, configuration, API reference, contributing, and license sections.
Match Existing Documentation Style 
Analyze the current documentation style in this repository. Update only missing documentation and preserve custom wording in existing comments.
Create API Reference From Source 
Build a structured API reference from these modules. Include public classes, methods, parameters, return values, exceptions, side effects, and realistic examples.

Best Practices

  • Provide representative source files and any existing documentation style before asking for updates.
  • Review generated examples for accuracy, especially around errors, side effects, and edge cases.
  • Keep generated documentation close to the code it describes.

Avoid

  • Asking for full project documentation without sharing source files or API context.
  • Replacing carefully written custom documentation without checking intent.
  • Publishing generated docs without verifying examples and installation steps.

Frequently Asked Questions

What languages does this skill support?
It gives patterns for JavaScript, TypeScript, Python, Rust, Java, and Go documentation.
Can it generate a full README?
Yes. It can draft overview, installation, usage, API, configuration, contribution, and license sections from project context.
Does it edit files automatically?
It provides documentation guidance. File edits depend on how the host agent is asked to apply the output.
Can it follow existing documentation style?
Yes. It instructs the agent to match existing project conventions and update only missing documentation.
Will it guarantee technical accuracy?
No. Generated docs should be reviewed against tests, implementation details, and product requirements.
Is network access required?
No. The skill text does not require network access or external services.

Developer Details

License

MIT

Skillstore revision

r1

Version notice

The author did not declare a version.

Repository

https://github.com/CuriousLearner/devkit/tree/main/skills/documentation-generator

Ref

d11af420e07cd866fe39cfa937efef3223896c06

Maintenance freshness

7/18/2026

Usage

8 downloads · 189 views

File structure

📄 SKILL.md