Editorial Guide

This guide defines how we write documentation and contributor-facing text in ArgDigest.

Goal: keep docs clear, operational, and easy to execute for humans and coding agents.

Core principles

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

2. Explicit over terse: prefer concrete instructions over short ambiguous statements.

3. Contract-aware writing: link canonical contract files and avoid conflicting paraphrases.

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 technical pages.

Maintenance rules

When behavior changes:

• update user docs for integration-impacting changes,

• update developer docs for workflow/architecture changes,

• update canonical guides when contract rules change.