I will audit your documentation and prepare an improvement plan
Principal Technical Writer, Documentation Systems Specialist
Informazioni su questo servizio
I will audit your technical documentation and identify what makes it hard to use, maintain, or scale.
This service is ideal for software products, developer tools, APIs, internal knowledge bases, and docs-as-code projects.
I will review:
- Structure, navigation, and information architecture
- Clarity, consistency, and completeness
- Missing, outdated, or duplicated content
- User flow and discoverability
- Formatting, terminology, and style issues
- Docs-as-code setup, if applicable
- Maintenance risks and improvement opportunities
You will receive a concise, practical audit report (1-2 pages) with prioritized findings and clear recommendations. The goal is not just to point out problems, but to help you understand what to fix first and why.
I am a senior technical writer with experience in complex software documentation, docs-as-code workflows, Git-based documentation, and customer-facing content.
Preferenza per lo stile di consegna
Informa il freelance di eventuali preferenze o preoccupazioni relative all'uso di strumenti di IA nel completamento e/o nella consegna dell'ordine.
