Write effective documentation for SaaS projects covering code comments, API docs, README files, and technical specifications. TRIGGER this skill automatically when the user mentions: writing docs, README, API documentation, JSDoc, TypeDoc, inline comments, "how do I document this", onboarding docs, CHANGELOG, technical spec, ADR (Architecture Decision Records), "the team doesn't understand this code", or any request to make code or systems easier to understand. Also trigger when public APIs or complex logic have no documentation.
Everything written for humans — inline DocC comments, .docc catalogues and tutorials, READMEs, blog posts and launch articles, and generated HTML/PDF documents. Apply when writing or reviewing documentation comments, a .docc article or tutorial, a README, a public post, or when building or verifying a rendered document or a deployed docs site.
Use when reviewing documentation concerns: README presence and quality, public API documentation, ADR coverage for non-obvious decisions, inline rationale comments, TBD/placeholder hygiene in shipped docs
Use when reviewing documentation concerns: README presence and quality, public API documentation, ADR coverage for non-obvious decisions, inline rationale comments, TBD/placeholder hygiene in shipped docs
Technical documentation workflow for capturing work done — decisions, commands, issues, and resolutions — into structured Markdown notes saved to an Obsidian vault.
Writing documentation people actually read — READMEs, API docs, ADRs, comments, changelogs, and technical writing style. Use when writing any docs, README, comments, or explaining a system in writing.
Create and update documentation articles for the Heym platform. Use when adding docs pages, writing reference articles from summaries, or when the user provides an outline for a new article.
1.3k6mo agoReviewMountCreate a free account to mount
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
13 projects use a version of this
1.1k8mo agoReviewMountCreate a free account to mount
Use whenever a change is user-facing — a new feature, a moved or removed button, a label, a shortcut, an option, a default, a note type, a collection view, an import format — or when asked to write, fix, restructure or audit Trilium's documentation ("document this", "update the User Guide", "add a page for X", "is X documented?", "which page describes X?", "the docs still say…", "rename/move this page", "add a screenshot", "which icon do I use?"). Covers the docs trees (`docs/User Guide`, `docs/Developer Guide`, `docs/Release Notes`) and the generated in-app help, `!!!meta.json` (noteId, shareAlias, iconClass, attachments), the User Guide house style (register, templates, reference pills, `<kbd>`, admonitions, figures, `bx`/`cke`/`tn-brand` icon spans), and `docs.mjs` (find/show/scaffold pages, register images, rename/move/delete, map a diff to affected pages, audit, regenerate the in-app help). A user-facing change is not finished until the User Guide describes it, in the same commit.
Steady4 mentions in 2 weeks
8 projects use a version of this
39k11d agoReviewMountCreate a free account to mount
Specialized skill for creating and editing high-quality Kener documentation. MUST be used whenever creating or editing documentation files in the src/routes/(docs)/docs/content/ directory or updating docs.json navigation.
Steady9 mentions in 2 weeks
36 projects use a version of this
5.2k8mo agoReviewMountCreate a free account to mount
Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Use when checking documentation style or validating MyST/reST syntax. Cites specific style guide violations.
1.3k8mo agoReviewMountCreate a free account to mount
How to write and maintain package-level (package-info.java) and module-level (module-info.java) Javadoc in JabRef, including deep links into devdocs.jabref.org. Use when adding a package or changing a package's or module's public surface.
Steady4 mentions in 2 weeks
No other project uses it yet
4.8k5mo agoReviewMountCreate a free account to mount
Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt. Use when writing or reviewing doc comments, documentation, adding code examples, setting up doc sites, or discussing documentation best practices. Triggers for both libraries and applications/CLIs.
Repository documentation placement and writing guidance. Use this skill whenever writing, modifying, reviewing, or planning README.md, anything under docs/, setup or installation instructions, troubleshooting or FAQ content, configuration references, operational guidance, or user-facing documentation in a feature or fix. Keep the README concise and put detailed material in its canonical documentation page.
88216d agoReviewMountCreate a free account to mount
Plain text files in a repository that tell a coding agent how the project works: commands to run, conventions to follow and things to avoid. CLAUDE.md, AGENTS.md, cursor rules and skills are the common kinds.
CLAUDE.md or AGENTS.md?
CLAUDE.md is read by Claude Code. AGENTS.md is an open format that Codex, Cursor and other agents read. Many projects keep one and point the other at it.
What is a skill?
A folder with a SKILL.md that describes one capability, such as filling PDFs or reviewing code. The agent loads it only when the task calls for it.
Can I search my own team's files too?
Your agents already can, over MCP, limited to the files you're allowed to read. Searching them from this page is coming.
psubramanianReads credentialsSkill
