#documentation Prompts

Write a detailed PRD for a new feature. Sections: 1. Overview (problem statement, goals, success metrics). 2. User personas and use cases. 3. User stories with acceptance criteria. 4. Functional requirements (detailed specifications). 5. Non-functional requirements (performance, security, scalabilit...

Create a production-quality Jupyter notebook template. Structure: 1. Markdown header with title, author, date, and objective. 2. Table of contents with anchor links. 3. Environment setup cell (imports, configs, random seed). 4. Exploratory Data Analysis section with visualizations. 5. Modeling secti...

Create developer-friendly API documentation. Structure: 1. Overview with quick start guide and authentication. 2. Endpoint reference with request/response examples. 3. Interactive API explorer (Swagger/Postman style). 4. Code samples in multiple languages (Python, JavaScript, cURL). 5. Error codes a...

Document a complete design system in code. Components to include: 1. Typography scale (H1-H6, Body, Caption). 2. Color variables for Primary, Secondary, Error, Success. 3. Button set (Primary, Outline, Ghost, Sizes). 4. Modal/Dialog patterns. 5. Form inputs with error states. Use Storybook for docum...

Create a professional README.md for an open-source project. Essential sections: 1. Project title with logo and badges (build status, version, license). 2. One-line description and key features. 3. Installation instructions with code blocks. 4. Quick start guide with minimal example. 5. API reference...

A tool to auto-generate Hugging Face model cards. Sections to include: 1. Model Description (Architecture, Parameters). 2. Training Data (Datasets used). 3. Evaluation Results (MMLU, HumanEval scores). 4. Intended Use and Biases. 5. Citation info. Minimalist layout with badges for 'Transformers', 'P...

Create and maintain comprehensive product documentation ecosystem. Documentation types: 1. User guides: step-by-step instructions for end users. 2. API documentation: endpoints, parameters, examples. 3. Admin documentation: configuration, troubleshooting. 4. Developer docs: SDKs, integration guides....

Write effective code documentation. Levels: 1. Code comments (explain why, not what - complex logic only). 2. Function/method docs (parameters, return values, exceptions - JSDoc, docstrings). 3. README (setup, usage, examples). 4. API documentation (OpenAPI/Swagger for REST). 5. Architecture docs (s...

Generate documentation for the following TypeScript function in JSDoc format. The function accepts a user object and returns a formatted greeting string. Make sure to document the parameters, their types, and the return value.

Scale through process documentation. Approach: 1. Document recurring processes. 2. Standard Operating Procedures (SOPs). 3. Decision-making frameworks. 4. Tools and system guides. 5. Video walkthroughs. 6. Knowledge base. 7. Version control for updates. 8. Ownership assignment. Use Notion or Conflue...

Create compelling sales proposals. Structure: 1. Executive Summary (1 page): problem, solution, value, investment. 2. Customer Situation (0.5 page): restate their pains from discovery. 3. Proposed Solution (2 pages): how you solve each pain point, features mapped to benefits. 4. Implementation Plan ...

Create clear, usable technical documentation that reduces support burden. Documentation hierarchy: 1. Getting started guide: installation, setup, first successful use. 2. User guides: task-oriented instructions with screenshots. 3. API reference: endpoints, parameters, examples, error codes. 4. Trou...

Provide technical specifications. Format: 1. Confirm exact product model. 2. Provide comprehensive spec sheet. 3. Include dimensions, weight, materials. 4. List technical requirements (power, connectivity). 5. Provide performance metrics. 6. Include certifications and compliance. 7. Link to detailed...

Create comprehensive sales playbook for consistency. Sections: 1. ICP and Buyer Personas (who we sell to, pain points, motivations). 2. Value Propositions (core message, differentiation per persona). 3. Sales Process (stages, exit criteria, average time per stage). 4. Methodology (MEDDIC, Challenger...

Create comprehensive API documentation for a RESTful service. Sections to include: 1. Authentication methods (API key, OAuth 2.0). 2. Endpoint reference with HTTP methods, parameters, and response schemas. 3. Code examples in Python, JavaScript, and cURL. 4. Error codes and troubleshooting guide. 5....

Create a comprehensive PRD (Product Requirements Document) template. Sections: 1. Executive Summary (Problem, Solution, Success Metrics). 2. User Stories and Personas. 3. Functional Requirements (Must-have vs Nice-to-have). 4. Technical Constraints and Dependencies. 5. Success Criteria and KPIs. 6. ...

Write comprehensive PRDs for complex product features. PRD structure: 1. Executive Summary (2-3 sentences): what you're building and why. 2. Problem Statement: user pain points with supporting data. 3. Success Metrics: how you'll measure success (leading and lagging indicators). 4. User Stories: cor...

Document components effectively with Storybook 7. Setup: 1. CSF3 format for stories. 2. Autodocs for prop table generation. 3. Controls addon for prop manipulation. 4. Actions addon for event logging. 5. Interactions testing with @storybook/test. 6. Accessibility checks with a11y addon. 7. Design to...