Results for “documentation”

I'm leaving my job as [role] in [weeks]. Create a handover plan (documentation, open projects, contacts), a farewell email to colleagues, a LinkedIn message for close contacts, and tips for the exit interview.

Create a code review checklist for a team working in [stack]. Cover correctness, readability, tests, security, performance, error handling, logging, documentation and style. Add tips for giving kind, actionable review comments.

Create a remote onboarding plan for a new [role]. Include pre-start setup (equipment, accounts), day-one schedule, first-week buddy and meetings, documentation to read, 30-day goals and check-ins. Make it warm and practical.

Write a documentation page for [feature/API/tool] aimed at [audience]. Include an overview, prerequisites, step-by-step setup, a code or configuration example, common errors with fixes, and related links. Use clear headings and second person. Base it on these notes: [notes].

Write a standard operating procedure for [task] at [company/team]. Include purpose, scope, roles, tools needed, numbered step-by-step instructions, quality checks, what to do if something goes wrong, and a revision date field. Base it on: [how we do it today].

Turn this code into documentation. Code: ``` [paste] ``` Provide: a plain-English step-by-step description, a Mermaid flowchart (or sequence diagram if it involves multiple services), the inputs and outputs, and any edge cases visible in the logic.

Act as a technical writer. Product: [name] Feature: [feature] Users: [who, skill level] Steps to use the feature: [describe] Write a help article: what the feature does, before you start, numbered steps with UI labels in bold, screenshots placeholders, tips, troubleshooting, and related articles. Use second person and…

Add documentation to the code below. Language: [language] Docstring style: [Google / NumPy / JSDoc / PHPDoc] Rules: - Add a docstring to every public function/class: purpose, parameters, return value, exceptions, example - Add inline comments only where logic isn't obvious, explaining WHY - Don't change any behaviour…

You are an API technical writer. API: [name and purpose] Base URL: [url] Auth: [API key / Bearer token / OAuth] Endpoints: [method, path, what it does, parameters, request body, responses] Create: 1. An OpenAPI 3.0 YAML spec with schemas, examples and error responses 2. A getting-started guide (auth, first request wit…

You are a technical writer for developer tools. Write a README.md for my project. Project name: [name] What it does: [description] Who it's for: [audience] Tech stack: [languages, frameworks] How to install: [steps or commands] Main features: [list] Configuration options: [env vars, config files] License: [license] Se…

Act as an operations manager. Write a Standard Operating Procedure for: [task or process] Who performs it: [role] Tools used: [software, equipment] How often: [daily / weekly / per order] How I currently do it: [describe the process in your own words, even if messy] Format: 1. Purpose and scope 2. Roles and responsibi…