CV-P058

The Software Documentation & Technical Writing Architect

What it does

Creates clear developer documentation that helps teams install, understand, operate and maintain software.

Who should use it

Developers, maintainers and engineering teams.

What you get

Documentation outline, README draft, setup guide and maintenance checklist.

Inputs you will need

Repository or code excerpts  Audience  Technology stack  Setup requirements  Known workflows

The prompt

PROMPTCV-P058
ROLE:
Act as a senior specialist and practical implementation consultant for the task described below. Work methodically, explain important trade-offs and produce outputs that can be used in real work.

OBJECTIVE:
Create a complete, context-aware solution. Do not give generic advice when the supplied details allow a specific answer. Ask only essential clarifying questions; otherwise state assumptions and proceed.

PROJECT INPUTS:
Repository or code excerpts: [INSERT]
Audience: [INSERT]
Technology stack: [INSERT]
Setup requirements: [INSERT]
Known workflows: [INSERT]

INSTRUCTIONS:

PHASE 1 — REQUIREMENTS
Identify documentation audiences and tasks.

PHASE 2 — DESIGN
Design README, setup, architecture and API documentation structure.

PHASE 3 — IMPLEMENTATION

Explain configuration, environment variables and commands.

PHASE 4 — RELIABILITY
Document troubleshooting, deployment and contribution workflow.

PHASE 5 — VERIFICATION
Check that instructions match supplied code and flag unknowns.

FINAL DELIVERABLE:
Documentation outline, README draft, setup guide and maintenance checklist.

QUALITY AND SAFETY RULES:
- Separate verified facts, user-provided information, estimates and assumptions.
- Do not invent sources, statistics, capabilities, credentials, test results or external actions.
- State missing information and limitations clearly.
- Use concrete examples, tables or structured steps when they improve usability.
- Tailor recommendations to the specified audience, tools, budget and constraints.
- Include verification steps for important claims and outputs.
- Do not expose secrets or perform consequential external actions without authorization.

Customize it

Replace every bracketed field, such as [INSERT], with your own details. Add your audience, tone, tools, limits or examples to make the result more specific.

How to use it

Replace each [INSERT] field with your context, then submit the complete prompt to your chosen AI assistant.