Client-ready reports¶

Sometimes the fastest way to write a report is Markdown.

Sometimes the right way to send it is a polished PDF or DOCX.

OpenDocs connects those two worlds without forcing you to rebuild the report in a document editor.

The problem¶

Consultants, agencies, analysts, and technical teams often produce reports from structured notes:

• findings
• recommendations
• screenshots
• tables
• implementation plans
• appendix material

Markdown is perfect while drafting. It is less perfect when the client expects a branded document, a stable link, or a Word file they can comment on.

OpenDocs keeps the source simple and makes the output presentable.

The OpenDocs workflow¶

Create a project for the client or engagement:

opendocs project create "Acme security review" --slug acme-security-review --use

Publish working drafts to the workspace:

opendocs publish ./reports/acme-security-review --tags client-report,security

Export the final report:

opendocs export executive-summary --format pdf --output ./executive-summary.pdf
opendocs export technical-findings --format docx --output ./technical-findings.docx

What makes this better than copy-paste¶

You do not have to paste Markdown into Google Docs and clean up formatting.

You do not have to maintain a custom PDF script.

You do not have to choose between a developer-friendly source format and a client-friendly output format.

The report can be written by a human, drafted by an agent, or assembled from both. OpenDocs handles the publishing and export layer.

A common report project¶

acme-security-review/
  executive-summary.md
  technical-findings.md
  remediation-plan.md
  appendix.md

Each document can have its own URL, tags, and export. The whole engagement stays grouped inside one project.

When to use this¶

Use OpenDocs when a report needs to move through several states:

1. rough Markdown notes
2. internal review
3. polished web link
4. PDF or DOCX export
5. future updates

That path is common for client work. OpenDocs makes it boring in the best way.

A good default¶

Keep drafts at workspace visibility. Export or share only when the document is ready.

If you need a client-facing URL, make just that final document public:

opendocs visibility executive-summary public --confirm-public

The project remains a private working area. The final output can travel.