Consulting Template Kit

Ship reusable consulting and technical-writing documents with a validator before reuse.

Consulting Template Kit packages public-safe statements of work, engagement letters, invoices, project briefs, proposal emails, and technical-writing templates. It also includes a validator that catches placeholders, private data shapes, and release mistakes before a template is sent or published.

Why it matters

Client-facing documents should be clear, reusable, and scrubbed before delivery. This repo gives developers and consultants a small template library with a repeatable validation receipt instead of ad hoc copy/paste checks.

Try it

python -m pip install -e .
python scripts/validate_templates.py templates examples
python -m pytest

What to test first

• Run the validator over templates/ and examples/.
• Copy one template and keep bracketed placeholders until final fill-in.
• Run ctk-validate templates examples after editable install.

Current status

Python package and CLI with public-safe templates, examples, and tests. These are starter documents, not legal, tax, accounting, or compliance advice.

Existing technical notes

Public-safe consulting & technical-writing templates: document kits and process scaffolds.

The kit is intentionally plain: statement of work, engagement letter, invoice, proposal email, project brief, and technical-writing cover letter templates. It includes a validator that catches common release mistakes before a template is reused or published.

What Is Included

• templates/engagement-letter.md
• templates/statement-of-work.md
• templates/invoice.md
• templates/proposal-email.md
• templates/technical-writing-cover-letter.md
• templates/project-brief.md
• examples/example-project-brief.md
• src/consulting_template_kit/validator.py (the installable package and ctk-validate console script)
• scripts/validate_templates.py (no-install wrapper around the package)

Quick Start

python -m pip install -e .
python scripts/validate_templates.py templates examples

The validator flags:

• secret-shaped text
• private contact placeholders that should remain generic
• payment-account wording
• suspicious personal/customer data patterns
• templates without bracketed placeholders

Use

Copy a template, replace bracketed placeholders, and run the validator against the finished draft before sending it.

ctk-validate templates examples

A clean run prints nothing and exits 0; findings are printed one per line and exit 1. See USAGE.md for the full command-line reference, the finding codes, the Python API, and worked examples.

Boundaries

These files are not legal, accounting, tax, or compliance advice. They are starter documents for scoping, communication, and operational hygiene.

Do not publish filled versions that contain client names, payment details, private rates, addresses, or signed terms.

---

Zain Dana Harper -- small tools with explicit edges. Portfolio · HarperZ9 _{Built with Claude Code; reviewed, tested, and owned by me.}

For developers

Keep the public README, package metadata, and examples aligned with current behavior. Before opening a PR or pushing a release, run the local package verification path.

python -m pip install -e ".[test]"
python -m pytest

---

Zentropy Labs · order out of entropy. An independent lab building evidence-first tools that leave a re-checkable artifact behind. Built by Zain Dana Harper in Seattle. The full workbench is at Project Telos.