Inspect before downloading
See what is inside
These previews come from the published bundle files, so you can judge the method and writing before using it.
Role guide
Technical Writer source-backed Guide
Defines source-backed technical documentation, evidence handling, and action boundaries.
Read the fileOverview
Technical Writer overview
Use this bundle to prepare source-backed technical documentation analysis and a review-ready technical documentation brief.
Read the fileWorkflow
Technical Writer source-backed triage
1. State the requested decision or artifact. 2. Inventory evidence: audience, tasks, product, versions, platforms, and documentation objective; authoritative requirements, code, APIs, UI.
Read the fileTemplate
technical documentation brief
Review-ready artifact for technical documentation, evidence quality, verification, and controlled next actions.
Read the fileIs this bundle right for your task?
Who it is for
- People performing or supporting Technical Writer work, plus teams reviewing its decisions and outputs
- Teams working in Technical communication, Software
When to use it
- A Technical Writer task needs a structured plan, evidence checklist, or review-ready output.
- A recommendation needs its assumptions, owners, risks, dependencies, and success measures made explicit.
What you need to provide
- The task objective, intended audience, working context, constraints, source material, and decision owner.
- Relevant reports, exports, examples, policies, prior decisions, and success measures available for the task.
Tasks and expected outputs
Questions it helps answer
- Prepare a technical documentation brief without fabricating local facts.
- Separate verified, provided, assumed, and missing evidence.
- Produce a review-ready recommendation with explicit verification and approval boundaries.
What it helps produce
- technical documentation brief
Practical example
Use it with an agent
Load the bundle as context, provide the evidence named above, then adapt this example to your situation.
Provide the task objective, intended audience, working context, constraints, source material, and decision owner. Ask the agent to approach Technical Writer work by producing technical documentation brief with a prioritized plan, evidence checks, owners, risks, and unresolved questions. Begin with O*NET OnLine — Summary / 27 3042.00, then confirm that the reference is current and applicable. Inspect Technical Writer source-backed Guide before drafting.
Context path: bundles/roles/technical-writer
What the bundle includes
Frameworks
- source-evidence matrix
- technical documentation review matrix
- qualified-review gate
Evaluations
- Technical Writer source verification check
Sources used to build this bundle
These are the public references behind the role definition and operating guidance. The bundle does not replace current documentation or evidence from your site.
Limitations and safe use
Do not use this for
- Treating the bundle as a substitute for organization-specific authority, firsthand evidence, or accountable review.
Known limitations
- Use the cited official, originator, standards, or professional sources for general technical documentation context; local facts, records, values, states, and permissions require inspected evidence.
- Task-specific work requires current evidence for audience, tasks, product, versions, platforms, and documentation objective; authoritative requirements, code, APIs, UI, configurations, and subject-matter owners; tested procedures, prerequisites, permissions, examples, expected results, and failure states; terminology, style, localization, accessibility, security, legal, and licensing constraints; review, version control, publication, maintenance, analytics, and feedback.
- Do not infer product behavior, command result, API contract, procedure safety, version applicability, content accuracy, or publication approval.
Safety notes
- Minimize personal, customer, employee, financial, credential, security, privileged, and other sensitive data.
- Require explicit confirmation before running consequential commands, publishing documentation, exposing secrets, making compliance claims, or changing product behavior.
- Route legal, privacy, security, compliance, financial, employment, safety, and other qualified judgments to an evidenced accountable reviewer.