The CHT Documentation Style Guide

francesca · November 15, 2019, 7:41pm

Interested in writing or improving documentation for the Community Health Toolkit? Check out our style guide, created by community member Rajakavitha1!

Have a suggestion or want to make an addition? Create a pull request or post below!

github.com

medic/medic-docs/blob/master/development/docs-style-guide.md#using-we

# Documentation Style Guide

This style guide provides a set of editorial guidelines for anyone writing developer documentation for Medic Mobile or Community Health Toolkit projects. These are guidelines, not rules. Use your best judgment. 

**Note:** medic-docs does not involve release management and acceptance testing. Help us maintain the quality of our documentation by submiting a pull request (PR) with any suggested changes. One of the repository's maintainers will review the PR, request additional changes as needed, and merge the PR when it is ready.

## Table of Contents
- [Language](#language)
- [General guidelines and best practices](#general-guidelines-and-best-practices)
    - [Present tense](#present-tense)
    - [Active voice](#active-voice)
    - [Simple and direct language](#simple-and-direct-language)
    - [Address the reader as "you"](#address-the-reader-as-you)
    - [Latin phrases](#latin-phrases)
- [Practices to avoid](#practices-to-avoid)
    - [Using "we"](#using-we)
    - [Using jargon and idioms](#using-jargon-and-idioms)
    - [Using statements about the future](#using-statements-about-the-future)
    - [Using statements that will soon be out of date](#using-statements-that-will-soon-be-out-of-date)
- [Formatting standards](#formatting-standards)

This file has been truncated. show original

marc · July 10, 2020, 2:46am

Happy to say that the style guide is now a key part of the documentation site: Documentation Style Guide | Community Health Toolkit

It helped us out as we consolidated materials for the relaunch of the doc site, and we’re updating it as we go. The source file has changed location, but you can get to the markdown page from the “Edit this page” link if you want to contribute further edits.