Write Docs

🏢Official
by tldraw · vlatest · Repository

Automatically generate clear, concise documentation from tldraw diagrams and associated notes.

Install on your platform

We auto-selected Claude Code based on this skill’s supported platforms.

1

Run in terminal (recommended)

terminal
claude mcp add write-docs npx -- -y @trustedskills/write-docs
2

Or manually add to ~/.claude/settings.json

~/.claude/settings.json
{
  "mcpServers": {
    "write-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@trustedskills/write-docs"
      ]
    }
  }
}

Requires Claude Code (claude CLI). Run claude --version to verify your install.

About This Skill

What it does

This skill allows AI agents to generate documentation. It can produce text suitable for user guides, API references, or internal knowledge bases. The generated documents are intended to be clear and concise, facilitating understanding of complex topics.

When to use it

  • Creating a quickstart guide for new users of a software product.
  • Generating API reference documentation from code comments.
  • Drafting internal training materials for onboarding new team members.
  • Automating the creation of release notes based on commit messages.

Key capabilities

  • Documentation generation
  • Text clarity and conciseness
  • Suitable for user guides, API references, and knowledge bases

Example prompts

  • "Write a short guide explaining how to use the 'lasso' tool in tldraw."
  • "Generate documentation for the /add endpoint of our API, based on these code comments: [code comments]."
  • "Create release notes summarizing the changes in version 2.3.0, using these commit messages as input: [commit messages]."

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and completeness of the source material provided (e.g., code comments or existing text). Providing detailed context will yield better results.

Tags

🛡️

TrustedSkills Verification

Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.

Security Audits

Gen Agent Trust HubPass
SocketPass
SnykPass

Details

Version
vlatest
License
Author
tldraw
Installs
0

🏢 Official

Published by the company or team that built the technology.