PA

packages-documentation

Tools for writing and formatting API references, docstrings, and migration guides for developer-facing libraries.

Install

mkdir -p .claude/skills/packages-documentation && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/5311" && unzip -o skill.zip -d .claude/skills/packages-documentation && rm skill.zip

Installs to .claude/skills/packages-documentation

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Write, update, and format documentation for @data-client public APIs - API reference (Docusaurus/MDX), README files, JSDoc/TSDoc docstrings, usage examples, migration guides, deprecation notices, changelog entries. Use when changing exported APIs (docs must update in the same PR), writing new package docs, or updating the dataclient.io site.
343 chars✓ has a “when” triggerlonger than Claude Code's old 250-char listing cap (fine on current versions)
Intermediate

Key capabilities

  • →Write API reference documentation
  • →Create README usage examples
  • →Document JSDoc/TSDoc strings
  • →Maintain migration guides
  • →Update deprecation notices

How it works

The skill enforces a documentation structure where API changes must be accompanied by updated reference files, usage examples, and migration notes in the same PR.

Inputs & outputs

You give it
Code changes in public APIs
You get back
Updated documentation files

When to use packages-documentation

  • →Update API documentation
  • →Generate README usage examples
  • →Create migration guides for new versions

About packages-documentation

Structures technical documentation into API reference, guides, and conceptual articles. Uses standard formats like MDX for easy publication.

Write, update, and format docs for public APIs - API reference, README, docstrings, usage examples, migration guides, deprecation notices

When not to use it

  • →Task involves internal or private APIs
  • →Task is unrelated to public library documentation

Limitations

  • →Internal or private APIs do not require documentation updates
  • →Documentation must be updated in the same commit or PR as code changes

How it compares

It mandates documentation updates as part of the code change process rather than as a separate, later task.

Compared to similar skills

packages-documentation side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
packages-documentation (this skill)14moNo flagsIntermediate
docs-write227moNo flagsBeginner
content-research-writer1511moNo flagsBeginner
doc-coauthoring1610moNo flagsBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

docs-write

metabase

Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

22139

content-research-writer

ComposioHQ

Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.

15111

doc-coauthoring

anthropics

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

1686

research-grants

davila7

Write competitive research proposals for NSF, NIH, DOE, and DARPA. Agency-specific formatting, review criteria, budget preparation, broader impacts, significance statements, innovation narratives, and compliance with submission requirements.

694

teams-channel-post-writer

daymade

Creates educational Teams channel posts for internal knowledge sharing about Claude Code features, tools, and best practices. Applies when writing posts, announcements, or documentation to teach colleagues effective Claude Code usage, announce new features, share productivity tips, or document lessons learned. Provides templates, writing guidelines, and structured approaches emphasizing concrete examples, underlying principles, and connections to best practices like context engineering. Activates for content involving Teams posts, channel announcements, feature documentation, or tip sharing.

591

write-docs

tldraw

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

665

Search skills

Search the agent skills registry