Tag

#documentation

6 prompts
Document a Function or Module

Complete JSDoc or docstrings with precise types, throws, constraints, and a usage example.

Document What You Built

Update docs strictly from the diff, with no invented features.

Function From Requirements

A typed, documented function built to spec — with three unit tests covering the edge and error cases.

Pull Request Description

Turn a diff into a scannable PR write-up with risks, rollback, and a reviewer checklist.

Write a README

A no-fluff README with only the sections your project actually needs filled in.

Code Documentation Generator

Generate clear docs for a chunk of code — overview, parameters, usage, and gotchas.