Skills documentation-templates
📦

documentation-templates

Content revision r2 Safe ⚙️ External commands

Create Clear Project Documentation

Inconsistent documentation makes projects difficult to understand and maintain. This skill provides adaptable templates for common technical documentation.

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-templates" from https://skillstore.io/skills/sickn33-documentation-templates.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-templates/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.

Test it

Using "documentation-templates". Create a README outline for a command-line log analyzer.

Expected outcome:

A structured outline covering purpose, installation, quick start, commands, configuration, usage examples, troubleshooting, contributing, and license.

Using "documentation-templates". Document the endpoint that retrieves an account by identifier.

Expected outcome:

An endpoint reference with purpose, identifier requirements, success behavior, not-found behavior, and representative request and response descriptions.

Using "documentation-templates". Record the decision to use PostgreSQL instead of SQLite.

Expected outcome:

An ADR describing scalability needs, the accepted PostgreSQL choice, considered alternatives, migration costs, operational requirements, and expected benefits.

Security Audit

Safe
v5 • 7/23/2026 Open versioned report

All 15 static findings are false positives caused by fenced documentation examples and ordinary template wording. The skill contains no executable commands, system reconnaissance, prompt injection, or other semantic security concerns.

1
Files scanned
205
Lines analyzed
0
Review items
0
False positives ignored
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-templates/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-templates/security.svg)](https://skillstore.io/skills/sickn33-documentation-templates?utm_source=security_passport_badge)

HTML badge

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

Embed card

<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-templates.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-templates security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-templates/audits/5

BibTeX citation

@techreport{sickn33-sickn33-documentation-templates-2026, author = {sickn33}, title = {documentation-templates security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/sickn33-documentation-templates/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-templates 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-templates/audits/5" identifiers: - type: other value: "skillstore:sickn33-documentation-templates:audit:5" description: "Skillstore immutable audit report identifier"

Skillstore Score

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

What You Can Build

Launch a Project README

Build a concise README that helps contributors install, configure, and understand a new project.

Standardize API References

Apply one endpoint structure across parameters, responses, errors, and examples.

Record Architecture Decisions

Capture decision context, status, consequences, and tradeoffs in a repeatable format.

Try These Prompts

Create a Basic README
Create a README for [project]. Include a one-line purpose, quick start, key features, configuration, documentation links, and license.
Document an API Endpoint
Document [method and path]. Describe its purpose, parameters, successful response, common errors, and one realistic request and response example.
Write an Architecture Decision
Draft an ADR for [decision]. Explain the context, chosen option, rejected alternatives, current status, consequences, and known tradeoffs.
Design an AI-Friendly Documentation Set
Design documentation for [project] that supports people and retrieval systems. Include navigation, self-contained sections, an llms.txt outline, key concepts, and update ownership.

Best Practices

  • Replace every placeholder with verified project information before publishing.
  • Keep examples realistic and update them when behavior changes.
  • Organize content from quick answers to detailed references.

Avoid

  • Do not publish a template with unresolved placeholder text.
  • Do not document behavior that has not been verified against the project.
  • Do not repeat the same details across several files without clear ownership.

Frequently Asked Questions

Which documentation types are included?
The skill covers README files, API endpoints, code comments, changelogs, architecture decisions, llms.txt, and retrieval-friendly structures.
Does the skill generate documentation from source code?
No. It provides structures and guidance, but project facts must be supplied and verified.
Can I adapt the templates to an existing documentation standard?
Yes. Adjust headings, terminology, depth, and examples while preserving the required information.
Does it support API documentation?
Yes. The endpoint template covers purpose, parameters, response states, and examples.
How does it support AI-friendly documentation?
It recommends clear heading hierarchies, self-contained sections, structured examples, diagrams, and an llms.txt overview.
Should generated documentation be reviewed?
Yes. Verify all commands, interfaces, defaults, links, and examples against the current project.

Developer Details

Author

sickn33

License

MIT

Skillstore revision

r2

Version notice

The author did not declare a version.

Ref

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

Maintenance freshness

7/26/2026

Usage

9 downloads · 90 views

File structure

📄 SKILL.md