Skip to content

friendly-project/doclint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A flat image of a book with a broom on the cover Doclint

Doclint is a set of standards for writing documentation in user-friendly ways. These standards are based largely on the experience of professional writers in technical environments, journalism, and governments. Because of this, the standards set out in Doclint can largely be applied in other areas of writing too.

Getting started

At the moment, Doclint is only a set of written standards, without any automated linting capabilities. Until then, take some time to read through the documentation standards for your target language.

Currently, only English (EN) is supported. To track implementation of your target language, see #34.

Contributing

If you want to contribute to Doclint, read the contribution guidelines.

This project makes use of various open-source resources and inspirations. A full list of these resources can be found in the friendly! project's Attribution document.

This is part of the friendly! project.