Generate API docs, README files, and inline code comments.
10 prompts found
Write a technical specification for [FEATURE]. Include: title + author + date, problem statement, goals/non-goals, proposed solution (architecture, data model,…
Write a CONTRIBUTING.md for [PROJECT]. Include: code of conduct reference, development environment setup, code style/linting requirements, Git workflow (branch naming,…
Generate a Postman collection description for [API]. Include: collection name and description, environment variables (base URL, auth token, test data),…
Create a code walkthrough document for [PROJECT/MODULE]. Audience: new team members. Include: architecture overview diagram (ASCII or description), module-by-module breakdown…
Generate a changelog for version [VERSION] of [PROJECT]. Changes made: [LIST OF COMMITS/CHANGES]. Format: Keep a Changelog standard. Categories: Added,…
Write a user guide for [PRODUCT/FEATURE]. Audience: [USER TYPE]. Include: getting started (prerequisites, installation, first run), key concepts, step-by-step tutorials…
Write an Architecture Decision Record (ADR) for: [DECISION TOPIC]. Use the ADR template: Title, Status (Proposed/Accepted/Deprecated), Context (problem + constraints),…
Add meaningful inline comments to this [LANGUAGE] code: ``` [CODE] ``` Rules: explain WHY, not WHAT. Comment complex logic, business…
Generate complete API documentation for [API DESCRIPTION]. Include: overview, authentication guide (with examples), rate limiting, pagination, error codes table, endpoint…
Generate a comprehensive README.md for [PROJECT NAME]. Description: [DESCRIPTION]. Include: project title + badges, brief description, features list, tech stack,…