Skip to content

Design documents

Use

Once installed, the skill loads automatically when you ask your agent for a design document in Word. Example prompts, by situation:

New design documents

Claude builds the document from a script on your template and keeps its cover, change record and numbering.

  • Create a network security design document for the web apps in subscription X, using the template Template.docx, with diagrams from /drawing-architecture-diagrams.
  • Write the solution design for the payments platform on our Word template: purpose, scope, current state, target design and implementation plan.
  • Turn these architecture notes into a design document on Template.docx, with one landscape page for the diagram.

Assessments and findings

  • Turn these findings into a client assessment document on our template. Don't mention how the data was collected.
  • Write up the network review as a findings table with impact and recommendation, and state every fact as of today.
  • Mark anything we could not confirm as to be confirmed by the hub team.

Revisions

  • Update the design document: the private endpoint stays in its current subnet. Keep the change record.
  • Add a version 1.1 row to the change record and a section on DNS resolution, then refresh the table of contents.
  • Swap Figure 1 for the new diagram and keep the key flows table on the same page.

Checking a document

  • Run check on Design.docx and fix everything it reports.
  • Make this document read as written by a consultant: no em dashes, no bold lead-ins, no AI vocabulary.
  • Check the PDF for empty pages and table titles left at the bottom of a page.

Tips for good results

  • Give it the client's own template. The look comes from the template, so the document matches their others.
  • Give facts with a date. The skill states the configuration as of that date and never how it was gathered.
  • Pass client-specific words that must not appear with --banned.
  • Keep the generated build script next to the document; rerun it for the next revision.

Or use the library directly:

from docbuilder import DesignDoc, check, finalize
d = DesignDoc("Template.docx", "Out.docx")
d.replace_text("Document Subtitle", "Network Security Design")
d.change_record(["24-Sep-2026", "Initial draft", "1.0", "First issue for review"])
d.clear_body()
d.h1("Purpose"); d.para("This document describes the proposed design.")
d.save()
pdf = finalize("Out.docx")            # Windows with Word: TOC, fields, PDF
print(check("Out.docx", pdf) or "check: clean")
python scripts/docbuilder.py finalize Out.docx
python scripts/docbuilder.py check Out.docx --pdf Out.pdf --banned "internal-project-name"
python tests/selftest.py            # DOCB_WORD=1 adds the Word and PDF checks