tend-docs

The Diataxis framework organizes technical documentation into four quadrants: tutorials, how-to guides, reference material, and explanation. Aligning developer docs with Diataxis ensures each documentation page serves a single clear purpose and avoids mixed messaging across audiences.

To match existing repo conventions for technical documentation, detect and replicate the repository's frontmatter shape, version markers, changelog format, callout style, and cross-linking patterns. This ensures new docs integrate seamlessly and remain diff-friendly for code review.

Pulling context from GitHub issues, pull request discussions, and commit history captures the motivation behind features. Sourcing this contextual "why" ensures technical documentation accurately reflects intent rather than just describing software behavior.

You can tailor developer docs for newcomers, returning power users, operators mid-task, and integrators. Audience-targeted content automatically adjusts documentation pacing, depth, and assumed knowledge to match the specific needs of each technical group.

The best way to format technical documentation for git diffs is using a sentence-per-line formatting approach. This structure produces review-ready, diff-friendly documentation pages where changes are isolated cleanly to individual sentences.

You should avoid Diataxis for developer documentation when content mixes instructional steps with conceptual explanation, as the framework enforces strict quadrant separation. Diataxis requires each page to serve a single purpose rather than combining multiple documentation types.