beautiful-docs

Beautiful Docs est une référence organisée pour les personnes qui créent de la documentation destinée à des logiciels ou à d'autres projets utilisés par plusieurs utilisateurs. Il ne génère pas lui-même de la documentation ; à la place, il propose des liens vers des exemples reconnus et des ressources d'accompagnement. Les exemples de documentation couvrent des références de langages et de frameworks, des guides d'API, des manuels de systèmes d'exploitation, des bases de données et des services pour développeurs. Parmi les entrées figurent Redis Commands, GitHub Developer Docs, Django, Ruby on Rails, Stripe, Rust, MongoDB, FastAPI et Supabase. Certaines entrées mettent en avant des qualités particulières telles que des exemples interactifs, le versionnage, la recherche, une rédaction concise, des diagrammes, la navigation ou la prise en charge de plusieurs langues. Une deuxième section porte sur les ressources relatives à la rédaction technique et à la conception de documentation, notamment TomDoc, Write the Docs, le Google Developer Documentation Style Guide, API Blueprint et Diátaxis. La dernière section recense des outils permettant de générer, convertir, publier ou maintenir de la documentation, tels que Sphinx, MkDocs, Read the Docs, Slate, Docusaurus, VuePress, VitePress, Docsify, Pandoc et Doxygen. Le dépôt est maintenu au moyen de pull requests. Il est demandé aux contributeurs d'expliquer pourquoi un élément est utile, de s'identifier ou d'identifier le contributeur d'origine, et de préserver l'ordre d'ajout de la liste.