--- name: technical-writing-advanced description: Plan, edit, and improve complex technical documents, illustrations, code samples, and writing workflows involving LLMs. --- # Advanced Technical Writing Use this skill for substantial documents and intermediate writing problems. ## Workflow 1. Establish the document's reader, purpose, scope, and success criteria. For large work, inventory existing content and dependencies before restructuring. 2. Build an outline around reader tasks. Give sections meaningful names, order prerequisite concepts before dependent ones, and split content when readers have different goals. Provide navigation for long documents. 3. Edit in passes: structure and completeness first, then technical accuracy, examples and illustrations, then clarity, consistency, and proofreading. Resolve contradictions and mark claims that need an owner or verification. 4. Make each illustration answer a specific question. Add a useful caption and describe the takeaway in nearby text; ensure the content remains available to readers who cannot see the image. 5. Make sample code runnable or clearly label it as a fragment. State prerequisites, versions when relevant, setup, expected output, and cleanup. Check that names and snippets agree with surrounding instructions. 6. When using an LLM, provide relevant context and explicit constraints, verify generated claims and code against authoritative sources, and review for omissions, privacy, security, and consistency. The author remains responsible for the final content. ## References See [Technical Writing Two](references/) for the source lessons: - [Introduction](references/technical-writing-two-01.md) - [Self-editing](references/technical-writing-two-02-editing.md) - [Large documents](references/technical-writing-two-03-large-docs.md) - [Illustrations](references/technical-writing-two-04-illustrations.md) - [Sample code](references/technical-writing-two-05-sample-code.md) - [LLMs](references/technical-writing-two-06-llms.md) - [Summary](references/technical-writing-two-07-summary.md) Source: [Google Technical Writing Two](https://developers.google.com/tech-writing/two).