documentation-handbook

Documentation guide

Best practices for writing approachable and effective documentation

How to write high-quality friendly documentation that people want to read.

GitHub

294 stars
13 watching
31 forks
last commit: about 8 years ago

Related projects:

Repository Description Stars
hail2u/html-best-practices Best practices for writing maintainable and scalable HTML documents. 4,111
chrismedrela/docs-guide A documentation guide for software development 20
jitsi/handbook The Jitsi Handbook is a documentation website for the Jitsi project. 192
lornajane/developer-style-guide Provides guidance for technical writers on documenting complex software topics in an approachable and inclusive manner. 16
bolajiayodeji/technical-writing-template Provides guidelines and a template structure for writing technical articles about software development topics 501
leahneukirchen/styleguide A collection of guidelines and best practices for software development 443
nprapps/bestpractices A set of guidelines and conventions for software development best practices in the NPR Visuals team. 293
bsvino/jaiprimer A documentation project focused on explaining Jonathan Blow's programming language Jai. 1,816
sezgi/css-best-practices Guidelines for writing and refactoring clean CSS for improved readability, modularity, and efficiency 198
palash25/best-practices-checklist A collection of language-specific resources for best practices and idiomatic code writing in various programming languages. 951
jeko2000/git-style-guide A comprehensive guide to Git best practices and terminology 15
stevekwan/best-practices Guides for front-end developers on coding standards and best practices for JavaScript and CSS. 1,704
best-doctor/guides Comprehensive guidebook for developers working on the BestDoctor project 257
jonathanzwhite/less-in-practice Style guide for projects using LESS programming language 1
codeforamerica/howto A collection of simple guides to foundational tech tasks and best practices for common software development tasks. 174