documentation
Create Complete Technical Documentation
Technical teams need clear docs across APIs, releases, and migrations. This skill creates structured documentation with templates and practical examples.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "documentation" from https://skillstore.io/skills/89jobrien-documentation.md and its manifest at https://skillstore.io/api/skills/89jobrien-documentation/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.
Test it
Using "documentation". Create API docs for user and workspace endpoints.
Expected outcome:
A structured API reference with endpoint summaries, authentication requirements, parameters, response descriptions, errors, and usage examples.
Using "documentation". Generate a changelog from the last release commits.
Expected outcome:
Customer-facing release notes grouped into new features, improvements, fixes, security updates, and breaking changes.
Using "documentation". Write a migration guide for a major version upgrade.
Expected outcome:
An upgrade guide with prerequisites, changed behavior, ordered migration steps, rollback instructions, and a verification checklist.
Security Audit
SafeThe static findings are documentation examples, placeholder credentials, Markdown code fences, and writing guidance. I found no evidence of executable malware behavior, live network exfiltration, real secret access, or prompt injection in the reviewed files.
Risk Factors
โ๏ธ External commands (40)
๐ Network access (21)
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.
Copy report link
https://skillstore.io/skills/89jobrien-documentation/audits/6?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/89jobrien-documentation?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/89jobrien-documentation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/89jobrien-documentation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/89jobrien-documentation.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
Joseph OBrien. (2026). documentation security audit report (audit version 6) [Author version 1.0.1]. Skillstore. https://skillstore.io/skills/89jobrien-documentation/audits/6BibTeX citation
@techreport{joseph-obrien-89jobrien-documentation-2026,
author = {Joseph OBrien},
title = {documentation security audit report (audit version 6)},
institution = {Skillstore},
year = {2026},
number = {6},
url = {https://skillstore.io/skills/89jobrien-documentation/audits/6},
note = {Author version 1.0.1}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation security audit report (audit version 6)"
version: "1.0.1"
type: report
authors:
- name: "Joseph OBrien"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/89jobrien-documentation/audits/6"
identifiers:
- type: other
value: "skillstore:89jobrien-documentation:audit:6"
description: "Skillstore immutable audit report identifier"
Compare variants
5 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
89jobrien-documentation
2026-08-21
sickn33-documentation
2026-08-21
bfdcampos-documentation
2026-08-21
crazyswami-documentation
2026-08-21
daothihuong2111-documentation
2026-08-21
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Document a new API release
Create endpoint references, authentication notes, examples, and versioning guidance for a public or internal API.
Prepare customer release notes
Turn technical commits into clear changelog entries grouped by features, fixes, improvements, and breaking changes.
Plan an upgrade path
Create migration documentation with prerequisites, breaking changes, upgrade steps, rollback guidance, and validation checks.
Try These Prompts
Create a README for this project. Include the purpose, installation steps, quick start, main features, configuration, troubleshooting, and license notes.
Create API documentation for these endpoints. Include authentication, request parameters, response fields, error cases, examples, and versioning notes.
Write a migration guide from version A to version B. Include prerequisites, breaking changes, step-by-step upgrade instructions, rollback steps, and verification checks.
Generate customer-facing release notes from these commits. Group changes by impact, rewrite technical language, call out breaking changes, and follow this style guide.
Best Practices
- Provide real project context, target audience, and publishing format before requesting documentation.
- Review generated examples against the current codebase before sharing them externally.
- Keep generated documentation close to source changes so updates stay accurate.
Avoid
- Do not publish placeholder credentials, URLs, package names, or commands without review.
- Do not ask for broad documentation without source material or audience details.
- Do not treat generated release notes as final without product and engineering review.
Frequently Asked Questions
Can this skill create OpenAPI documentation?
Can it generate changelogs from commits?
Does it execute SDK generators?
Is it useful for non-API documentation?
What information should I provide?
Should generated docs be reviewed?
Developer Details
Author
Joseph OBrienLicense
MIT
Author version
v1.0.1
Skillstore revision
r1
Ref
c4037264bbd363c572662d6154a3ab28f5ca4f53
Maintenance freshness
7/18/2026
Usage
7 downloads ยท 542 views
File structure
๐ references/
๐ api-docs.md
๐ api-documentation.template.md
๐ architecture-decision-record.template.md
๐ changelogs.md
๐ migration-guide.template.md
๐ technical-writing.md
๐ SKILL.md