Editorial Guide

This guide defines documentation style for PyUnitWizard contributors.

Goal: keep docs clear, operational, and consistent with ecosystem standards.

Core principles

1. Narrative first: write guided paths, not disconnected notes.

2. Explicit over terse: prefer concrete instructions over vague summaries.

3. Contract-aware writing: link canonical sources when behavior is contractual.

4. Operational language: state what to run, what to verify, and expected outcomes.

Style rules

• Keep tone direct and technical.

• Prefer active voice.

• Avoid unexplained acronyms.

• Avoid marketing language in contributor pages.

Maintenance rules

When behavior changes:

• update User docs for integration-impacting changes,

• update Developer docs for workflow/architecture changes,

• keep docs and devguide/ synchronized.