Write Docs
OfficialAutomatically generate clear, concise documentation from tldraw diagrams and associated notes.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add tldraw/tldraw --skill write-docs -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
tldraw
Matched to the vendor's own GitHub organisation.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned tldraw/tldraw at fdd9b4dee0.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- fdd9b4dee0
- Manifest
- skills/write-docs/SKILL.md
- Scanned
- 1 file, 113 lines
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
/addendpoint 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.