davidbgk
/
larlet-fr-david
Watch 1
Star 0
Fork 0
Code Releases 0 Activity
Repository with sources and generator of https://larlet.fr/david/ https://larlet.fr/david/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
541 Commits
1 Branch
Tree: 6a8e1d1d6d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6a8e1d1d6d'
${ noResults }
larlet-fr-david/david/2021/sources/2021-09-09 - Documentation.md

2021-09-09 - Documentation.md 1.1KB
Raw Normal View History

Publishing
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 12345678910111213141516 
  1. # Documentation

  2. 

  3. > [en] Here are six requirements that I have on a project for it to reach my gold approval for stellar docs.

  4. > 

  5. > 1. Your docs belong in the code repository

  6. > 2. Your docs is not extracted from code

  7. > 3. Your docs features examples

  8. > 4. You document every API call you provide

  9. > 5. Your docs is easily accessible and browsed

  10. > 6. Your docs should be ==easy to contribute to==

  11. >

  12. > <cite>*[Making world-class docs takes effort](https://daniel.haxx.se/blog/2021/09/04/making-world-class-docs-takes-effort/)* ([cache](/david/cache/2021/f327a02cabbad6884b057958ec213668/))</cite>

  13. 

  14. J’ai mis en place un document collaboratif [dernièrement](/david/2021/09/01/) en prenant pour acquis que le markdown était lisible et éditable. *C’était une grossière erreur.* Même avec l’aide de hackmd, un document contenant principalement des liens est interprété comme étant trop technique pour être accessible à des personnes n’ayant pas cette habitude.

  15. 

  16. Un bon rappel que la route est [encore très longue…](https://degooglisons-internet.org/fr/) ([cache](/david/cache/2021/8589fdcb9656efb132e1513c07d48bd1/))