Skills documentation
📦

documentation

Content revision r1 Medium Risk ⚙️ External commands

Document TypeScript and React Projects

Teams often miss consistent API comments, component stories, and documentation updates. This skill guides TSDoc, Storybook, VitePress, and TypeDoc work in Claude, Codex, and Claude Code.

Supports: Claude Codex Code(CC)
📊 69 Adequate

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

Markdown detail GET /skills/crazyswami-documentation.md Signed manifest GET /api/skills/crazyswami-documentation/manifest Signed lockfile GET /api/skills/crazyswami-documentation/lockfile

Test it

Using "documentation". Document a loading button component.

Expected outcome:

  • A concise component summary for the public API.
  • Parameter descriptions for visual state and click behavior.
  • Storybook coverage for default, loading, disabled, and error-related states.

Using "documentation". Prepare API docs for a utilities package.

Expected outcome:

A TSDoc coverage plan, TypeDoc generation steps, and a review checklist for missing parameters and return descriptions.

Using "documentation". Add docs for a new VitePress page.

Expected outcome:

A page outline, sidebar placement guidance, and cross-link suggestions for related API reference pages.

Security Audit

Medium Risk
v8 • 7/6/2026 Open versioned report

All 28 static backtick findings are false positives caused by Markdown fences and inline code, not Ruby or shell backtick execution. I found one contextual medium risk: the skill permits Bash and recommends running pnpm documentation scripts, which can execute project-controlled package scripts. No prompt injection or exfiltration intent was found in SKILL.md.

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

Confirmed security concerns (1)

Medium
SKILL.md:4SKILL.md:113-120SKILL.md:140
Project Script Execution Guidance
The skill allows Bash and recommends pnpm documentation and Storybook commands. These commands can execute project-controlled package scripts if used in an untrusted repository.
SKILL.md explicitly allows Bash and documents pnpm commands, including a checklist item to run pnpm docs:api. The behavior is legitimate for documentation work but still creates execution risk in untrusted repositories.

Risk Factors

⚙️ External commands (28)
SKILL.md:22-30 SKILL.md:30-32 SKILL.md:32-34 SKILL.md:34-37 SKILL.md:37-45 SKILL.md:45-47 SKILL.md:47-49 SKILL.md:49-52 SKILL.md:52-57 SKILL.md:57-59 SKILL.md:59-61 SKILL.md:61-64 SKILL.md:64-69 SKILL.md:69-71 SKILL.md:71-73 SKILL.md:73-77 SKILL.md:77 SKILL.md:79-111 SKILL.md:111-117 SKILL.md:117-118 SKILL.md:118-119 SKILL.md:119-120 SKILL.md:120-126 SKILL.md:126 SKILL.md:127-128 SKILL.md:128-129 SKILL.md:129-130 SKILL.md:130-140
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/crazyswami-documentation/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

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

HTML badge

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

Embed card

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

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

BibTeX citation

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

Compare variants

5 installable variants

Each author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.

Why this variant is first

Highest Skillstore Score
Joseph OBrien Recommended

89jobrien-documentation

Skillstore Score 79
Evidence Confidence High
Skillstore usage 10
Updated

2026-08-21

sickn33

sickn33-documentation

Skillstore Score 78
Evidence Confidence High
Skillstore usage 15
Updated

2026-08-21

BfdCampos

bfdcampos-documentation

Skillstore Score 78
Evidence Confidence High
Skillstore usage 10
Updated

2026-08-21

CrazySwami Current

crazyswami-documentation

Skillstore Score 69
Evidence Confidence High
Skillstore usage 8
Updated

2026-08-21

DaoThiHuong2111

daothihuong2111-documentation

Skillstore Score 50
Evidence Confidence High
Skillstore usage 234
Updated

2026-08-21

Skillstore Score

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

What You Can Build

Add Component Stories

Create Storybook coverage for React components with default, loading, and error states.

Prepare API Reference

Add TSDoc comments and regenerate TypeDoc output for a TypeScript package.

Organize Documentation Pages

Place new VitePress pages and update sidebars when product documentation changes.

Try These Prompts

Add Basic TSDoc 
Add TSDoc comments to the exported functions in src/utils. Include parameters, returns, and one usage example for each.
Document a React Hook 
Document the exported hooks in src/hooks. Explain each option, returned state, returned actions, and common usage patterns.
Create Storybook Stories 
Create Storybook stories for the components in src/components. Include default, loading, error, and important empty states.
Build a Documentation Plan 
Review the public exports, Storybook coverage, VitePress pages, and TypeDoc setup. Propose a documentation plan and confirm before running project commands.

Best Practices

  • Review package scripts before running documentation or Storybook commands.
  • Keep examples short and tied to real public APIs.
  • Update generated docs and source comments in the same change.

Avoid

  • Adding comments that repeat names without explaining behavior.
  • Creating stories without loading, error, and empty states.
  • Running project scripts in untrusted repositories without review.

Frequently Asked Questions

Does this skill write TSDoc comments?
Yes. It guides comments for exported functions, hooks, components, interfaces, and types.
Does it support Storybook?
Yes. It includes story patterns for React components and common states.
Can it update VitePress documentation?
Yes. It points documentation pages to docs folders and reminds users to update sidebars.
Can it run documentation commands?
It may suggest pnpm commands. Review package scripts and confirm before running them.
Does it work for non-React projects?
It may help with TSDoc, but its Storybook guidance assumes React components.
Does it generate TypeDoc output by itself?
No. It guides the command and expected output location for projects that already use TypeDoc.

Developer Details

Author

CrazySwami

License

MIT

Skillstore revision

r1

Version notice

The author did not declare a version.

Repository

https://github.com/CrazySwami/cross-platform-web-app-research/tree/master/.claude/skills/documentation

Ref

d11af420e07cd866fe39cfa937efef3223896c06

Maintenance freshness

7/18/2026

Usage

5 downloads · 215 views

File structure

📄 SKILL.md