Documentation template and free outline generator

# [Product name] user guide Last updated: [date] Applies to: [version, plan or app] ## What [product name] does [Two or three sentences: the problem it solves and who it is for.] ## Before you start - You need: [account type, permissions, device or browser] - Have ready: [files, details or codes the reader needs] ## Get started 1. [First action, such as signing in or opening the app.] 2. [Action that gets the reader to a first useful result.] 3. [Check: what the reader sees when this worked.] ## [Main task 1, written as a goal, such as "Invite your team"] 1. [Step.] 2. [Step.] Result: [what changes when the task is done]. ## [Main task 2] 1. [Step.] 2. [Step.] ## Settings | Setting | What it does | Default | |---|---|---| | [Name as shown on screen] | [Effect] | [Value] | ## Troubleshooting - **[Symptom the reader sees]:** [cause and fix]. - **[Symptom]:** [cause and fix]. ## Get help [Help center link], [support email or contact page], [hours, if you publish them].

# [Product name and model] user manual Model: [model number] Manual version: [version] Date: [date] ## Safety information [List the warnings that apply to this product. Put them before any setup step.] ## What is in the box - [Item and quantity] - [Item and quantity] ## Product overview [Diagram or photo with numbered parts.] 1. [Part name]: [what it does] 2. [Part name]: [what it does] ## Setup 1. [Unpack and place the product.] 2. [Connect power, cables or the app.] 3. [First start: what the reader sees.] ## Daily use ### [Task, such as "Start a cycle"] 1. [Step.] 2. [Step.] ## Care and maintenance - [Cleaning instruction and how often.] - [Parts to replace and when.] ## Troubleshooting | Problem | Possible cause | What to do | |---|---|---| | [Problem] | [Cause] | [Action] | ## Specifications [Size, weight, power, capacity, operating conditions.] ## Warranty and support [Warranty terms or link], [how to contact support], [where to find the serial number].

# Get started with [product name] in [number] steps This guide gets you from a new account to [first useful result]. For everything else, see the [full user guide link]. ## 1. [Create or sign in to your account] [One or two sentences and the button name to click.] ## 2. [Connect or import your first item] [What to choose, and what to leave at the default for now.] ## 3. [Do the first real task] [The action that shows the product working.] ## You are ready You can now [what the reader can do]. Next, try: - [Second task, with a link] - [Setting most teams change first, with a link] Stuck? [Contact link] or reply to [support email].

# [Question the customer asks, such as "How does billing work for added seats?"] [Answer in one or two sentences. A reader who stops here has what they need.] ## How it works [Two or three short paragraphs with the details. One idea per paragraph.] ## Example [A short worked example with real numbers from your own policy.] ## Limits and exceptions - [Plan, region or account type where this is different.] - [What this article does not cover, with a link to the article that does.] ## Related articles - [Article title and link] - [Article title and link] Still need help? [Contact link]

# How to [task, starting with a verb] You can [task] from [page or app area]. It takes about [time] and needs [role or permission]. ## Before you start - [Requirement, such as a plan, a permission or a file.] ## Steps 1. Go to **[Menu] > [Page]**. 2. Select **[Button name]**. 3. [Fill in or choose something.] If [condition], [alternative step]. 4. Select **[Save or Confirm]**. ## Result [What the reader sees when it worked, such as a message or a new item in a list.] ## Next steps - [Related task and link] ## If it did not work [Most common reason and fix, or a link to the troubleshooting article.]

# [Symptom in the customer's words, such as "I don't get the sign-in email"] ## What you see [Exact error message or behavior. Quote the message so search finds this page.] ## Try these fixes in order 1. **[Most likely cause]:** [fix in one or two steps]. Check: [how to tell it worked]. 2. **[Next likely cause]:** [fix]. 3. **[Less common cause]:** [fix]. ## Still not working? Contact [support link or email] and include: - [Detail support needs, such as the account email] - [Detail, such as the device and browser] - [A screenshot of the error, if there is one] ## Why this happens [Optional: one short paragraph for readers who want the reason.]

# [Verb] [resource], such as "Create a contact" `[METHOD] [/v1/path/{id}]` [One sentence: what the endpoint does and when to use it.] ## Authentication [Header name and format, such as Authorization: Bearer [token]. Link to the authentication page.] ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | [id] | [string] | Yes | [What it identifies] | ## Body parameters | Name | Type | Required | Description | |---|---|---|---| | [field] | [type] | [Yes or No] | [Meaning, allowed values, default] | ## Example request ```bash curl -X [METHOD] [base URL][path] \ -H "Authorization: Bearer [token]" \ -H "Content-Type: application/json" \ -d '[example body]' ``` ## Example response ```json [example response body] ``` ## Errors | Status | Code | Meaning | What to do | |---|---|---|---| | [400] | [code] | [Meaning] | [Fix] | ## Rate limits [Limit and what happens when it is reached, or a link to the rate limits page.]

# [Product name] API The [product name] API lets you [main things a developer can do]. It uses [REST and JSON, or your style] over HTTPS. ## Base URL `[https://api.example.com/v1]` ## Get an API key 1. Go to **[Settings] > [API keys]**. 2. Select **[Create key]** and copy it. You can see it only once. 3. Store it as a secret on your server. Never put it in browser or app code. ## Authenticate a request Send the key in the [header name] header: ``` [Header name]: [format, such as Bearer YOUR_KEY] ``` ## Your first request [A short curl example that returns something real, such as the current account.] ## Versioning [How versions are named, how you announce changes, how long old versions keep working.] ## Pagination, errors and limits - Pagination: [cursor or page parameters]. - Errors: [error body shape and a link to the error list]. - Rate limits: [limits or link]. ## SDKs and help [SDK links], [changelog link], [where developers ask questions].

# Webhook event: [event.name] Sent when [what happened, in one sentence]. ## When it is sent - [Trigger.] - Not sent when [case that surprises developers]. ## Payload ```json [example payload] ``` | Field | Type | Description | |---|---|---| | [field] | [type] | [Meaning] | ## Delivery and retries [How you sign requests, how to verify the signature, what counts as success, how retries work.] ## Example handler [A short code example that verifies the signature and reads one field.] ## Related events - [event.name]: [when it is sent instead]

# [Feature name] [One sentence: what the feature lets the reader do.] Available on: [plans] Who can use it: [roles] Released: [date] ## What it is for [The problem it solves, with one concrete example from a customer's day.] ## Turn it on 1. Go to **[Menu] > [Page]**. 2. [Switch, setting or permission.] ## Use it 1. [Step.] 2. [Step.] [Screenshot: what the reader should see.] ## Limits - [Size, count or plan limit, with the real number.] - [What it does not do yet, if customers will ask.] ## FAQ **[Question support expects]?** [Answer.] **[Question]?** [Answer.] ## Related [Links to settings, API or billing pages.]

# [Old feature or API version] is being retired **What changes:** [old thing] stops working on [date]. **What to use instead:** [new thing, with a link]. **Who is affected:** [accounts, plans or integrations]. If you do not use [old thing], you do not need to do anything. ## Timeline - [Date]: [announcement, new option available] - [Date]: [old option hidden for new accounts] - [Date]: [old option stops working] ## How to move to [new thing] 1. [Step.] 2. [Step.] 3. Check: [how to confirm the move worked]. ## What is different | [Old thing] | [New thing] | |---|---| | [Behavior] | [Behavior] | ## Questions [Contact link]. Tell us if the date does not work for you, and why.

# Runbook: [task or alert name] Owner: [team or role] Last tested: [date] Review by: [date] ## Use this runbook when [Alert name, symptom or request that starts it.] ## Do not use it when [Cases that need a different runbook, with links.] ## Access you need - [System and permission] - [Tool and permission] ## Steps 1. [Check the current state.] Expected: [what normal looks like]. 2. [Action.] Expected: [result]. 3. [Action.] If [unexpected result], stop and go to Escalation. ## Roll back 1. [How to undo step 3.] 2. [How to undo step 2.] ## Escalation If [condition], contact [role] through [channel]. Include [details they need]. ## After you finish - Record [what was done] in [ticket or log]. - Tell [who needs to know].

# [Situation agents handle, such as "Customer was charged twice"] Applies to: [products, plans or regions] Owner: [role] Updated: [date] ## How to recognize it [What the customer usually says, and what agents see in the account.] ## What to check 1. [Check in tool, with the page name.] 2. [Check.] ## What to do - If [condition]: [action, and the saved reply to use]. - If [condition]: [action]. - Never [action agents must not take, such as promising a date]. ## What to tell the customer [Approved wording or a link to the saved reply.] ## Escalate when [Condition], to [team] through [channel], with [details]. ## Customer-facing article [Link to the public help article, if one exists. If it does not, ask [owner] to write one.]