hermes

Start here 1

The general, start-from-zero entry for a need in this category: it works from a blank start, asks for what it needs and hands off to the specific entries. Example: Plan a trip.

Search and filter in Documentation
  • Write a how-to guide for one task

    Writes a how-to guide for a reader who knows the basics, with a goal-named title, prerequisites, numbered steps with expected results, a verification step and links instead of tangents.

Specific 86

One situation, audience, tool or format inside the category. Example: Plan a road trip with children.

  • Write a README

    Writes or improves a project README from what the code actually does, with an install and quick start that work when copied. Use for a new project or a README that has drifted.

  • Write a changelog entry

    Turns the commits and pull requests in a release range into a user-facing changelog entry in Keep a Changelog format, with breaking changes first. Use when cutting a release.

  • Write release notes

    Turns merged pull requests or commits into release notes for a chosen audience, grouped by impact and written as outcomes without internal jargon. Use when shipping a version.

  • Document a public API

    Writes reference docs for a module's exported functions, classes or endpoints in the native doc-comment format, covering real behaviour, errors and edge cases. Use before a release.

  • Write a migration guide

    Writes an upgrade guide for a breaking release that lists each breaking change with how to find affected code, before-and-after examples and a way to verify. Use when shipping a major version.

  • Technical writer

    Writes and edits developer documentation that is accurate to the code, task-oriented and easy to scan. Use as the voice for READMEs, API references, guides and changelogs.

  • Audit a documentation set

    Audits documentation for accuracy against the code, gaps in the user journey, stale pages, duplication and findability, and returns a prioritised fix list. Use before a docs overhaul or release.

  • Write a troubleshooting guide

    Writes a troubleshooting guide organised by symptom, with likely causes in order, diagnostic commands, fixes and when to escalate, from support tickets or issue threads.

  • Code comment rules

    Standing rules for the comments and docstrings an assistant writes - explain why not what, document public APIs fully, no commented-out code, owned TODOs, and keep comments true when code changes.

  • Write a step-by-step code tutorial

    Writes a technical tutorial a reader can follow end to end, with pinned prerequisites, complete runnable snippets and a checkpoint after every step. Use for docs, blog tutorials or workshop material.

  • Write a developer onboarding guide

    Writes an onboarding guide for a repository covering setup, an architecture map, first tasks and known gotchas, with every command checked against the repo. Use for new hires or contributors.

  • Comment complex code

    Adds why-comments to tricky code, such as non-obvious logic, workarounds, invariants and ordering constraints, without restating what the code already says.

  • Convert a diagram image to Mermaid

    Turns a whiteboard photo, screenshot or exported diagram into editable Mermaid or PlantUML of the right diagram type, listing every label or arrow it could not read instead of guessing.

  • Document API conventions

    Writes the API fundamentals page covering pagination, errors, rate limits, idempotency, versioning, timestamps and IDs, checked against how the real endpoints behave.

  • Document configuration options

    Writes a configuration reference from code or a schema, with every option and env var, its type, default, allowed values, precedence, restart needs and old names, kept in sync by generation.

  • Document error codes

    Turns the error codes and messages in a codebase or API into an error catalog with cause, fix, retry safety and a stable URL per error that the message can link to. Use for APIs, SDKs and CLIs.

  • Document a repo's task scripts

    Documents a repo's existing Makefile targets, npm scripts, justfile recipes or scripts folder with grouped descriptions, a help command and a developer commands section, without changing behaviour.

  • Document scheduled jobs

    Finds every cron job, scheduled task and recurring worker across code and infrastructure config, and documents schedule, time zone, purpose, failure impact and rerun steps.

  • Document webhook events

    Writes the webhook reference for an API, with an event catalog and example payloads, delivery and retry rules, ordering and duplicates, signature verification, endpoint requirements and testing.

  • Triage docs feedback

    Clusters docs feedback, page ratings, support tickets and failed searches into ranked fixes, each naming the page to change and what to change on it.

  • Write dataset documentation

    Documents a maintained dataset that a data team publishes for other teams or partners, with grain, schema and units, freshness, known gaps, privacy, change policy and an example query.

  • Write a developer cheat sheet

    Writes a one-page cheat sheet of the commands, patterns and gotchas for a tool, framework or repository, checked against the installed version or the repo itself.

  • Write a multi-platform installation guide

    Writes the installation page for a library or command-line tool across operating systems and package managers, with prerequisites, verification steps and fixes for common install failures.

  • Document a Jupyter notebook

    Adds a summary, section headings, explanations, stated assumptions and conclusions to a Jupyter notebook so a colleague can follow its reasoning and rerun it top to bottom.

  • Document a shell script

    Adds a usage header, a --help option, examples, environment variables, dependencies and exit codes to a shell script so someone else can run it safely, without changing what it does.

  • Annotate a config file

    Adds comments to a config file such as Kubernetes YAML, nginx, tsconfig or a CI pipeline, explaining each non-default setting, its default and why it is set.

  • Docs site overhaul track

    Overhauls developer docs in gated steps, from inventory and reader journeys to a new structure with redirects, rewritten top pages, tested code samples and a process that keeps docs current.

  • Document a data pipeline

    Documents a batch or streaming data pipeline with its sources and sinks, schedule, lineage, owners, failure handling, backfill and rerun instructions, checked against the orchestration code.

  • Document a permissions matrix

    Reads a product's authorization checks and documents what each role can do as a reference table for admins and support, with every cell traced to code.

  • Fix stale code comments

    Finds comments and docstrings that no longer match the code beside them, such as wrong parameters, old behaviour or dead TODOs, and fixes or deletes each one.

  • Reorganise docs by Diátaxis

    Sorts every page of a docs tree into tutorial, how-to, reference or explanation, finds pages that mix modes, and proposes a new navigation with splits, merges and redirects.

  • Write an API quickstart

    Writes an API quickstart that gets a developer to a first successful call in minutes, with credentials, one request, the expected response and common errors. Use for a new or hard-to-adopt API.

  • Write a CLI reference

    Writes the help text, man page and web reference for a command-line tool from its argument parser, with synopsis, options grouped by task, exit codes, environment variables and real examples.

  • Write a modding guide

    Writes a modding guide for a game's players, covering file layout, data formats, the scripting API, a first working mod in 15 minutes, load order, compatibility and what is unsupported.

  • Write a self-hosting guide

    Writes the self-hosting guide for a server application, covering requirements, install with Docker or packages, configuration, TLS, upgrades, backups and restore, and monitoring.

  • Document dbt models

    Writes dbt model and column descriptions in YAML with reusable doc blocks, stated grain, keys and tests, checked against the SQL, so the generated docs site answers analysts' questions.

  • Document cloud infrastructure

    Documents cloud infrastructure from Terraform and notes, with a resource inventory per environment, network diagram, access paths, environment differences and what code does not manage.

  • Improve OpenAPI descriptions

    Enriches a thin OpenAPI spec with operation summaries, parameter and field descriptions, examples and missing error responses so the generated reference is actually useful.

  • Write an embed installation guide

    Writes install instructions for a JavaScript widget or snippet across plain HTML, React, Next.js, WordPress and Shopify, with verification, consent and Content Security Policy notes.

  • Build an SDK example app

    Builds a small runnable example app for one framework that shows an SDK's main flows end to end, with a README, pinned versions, env-based config and a CI check that it still runs.

  • Document message topics and queues

    Writes a catalog of Kafka topics or message queues with owners, producers, consumers, schemas, keys, ordering, retention and dead-letter handling for internal teams.

  • Document a Protobuf and gRPC API

    Documents gRPC services and Protobuf messages with comments on every service, RPC, message, field and enum, the status codes each RPC returns, and generated reference pages.

  • Document a WebSocket or SSE API

    Documents a WebSocket or Server-Sent Events API with connection and auth, every message type in both directions, event sequences, heartbeats, reconnection and error handling.

  • Draw a database ER diagram

    Draws entity-relationship diagrams in Mermaid or DBML from a schema or ORM models, grouped by domain, with keys, cardinality from real constraints and relationships that exist only in code.

  • Edit a technical documentation draft

    Edits a developer docs draft in three passes - accuracy questions for the author, structure for the page type, then sentence clarity - with traceable edits, not a silent rewrite.

  • Generate a third-party notices file

    Generates a third-party notices file listing every shipped dependency with its licence text and copyright lines, from the lockfile and installed packages, ready to bundle.

  • Set up generated API reference docs

    Sets up API reference generated from doc comments with TypeDoc, Sphinx autodoc, rustdoc, Javadoc or similar, limited to the public surface, checked in CI and published per release version.

  • Set up a docs site

    Sets up a documentation site with Docusaurus, MkDocs Material, Sphinx or Starlight from existing Markdown, with navigation, search, optional versioning, broken-link checks and deploy on merge.

  • Translate code comments to English

    Translates comments, docstrings and developer log messages in a codebase into clear English, without touching code, identifiers or strings that users see.

  • Write an API authentication guide

    Writes the authentication page for an API covering API keys or OAuth 2.0 flows, scopes, token lifetime and refresh, auth errors and safe secret storage, with working examples.

Showing 50 of 86. See them all in search

Advanced 2

Expert or deep work that assumes the user can judge expert output. Example: Plan croissant lamination.

Not: non-technical writing (writing-communication domain); ADRs (architecture).