Read The Docs - Come scrivere la documentazione di progetto

categorie

Read The Docs è un servizio free online che permette di scrivere e conservare documentazione di progetto.

Sphinx è il tool di scrittura, realizzato in python e permette di redigere i documenti in reStructuredText e Markdown, gestire il versioning, ha una API per interagire in modo automatizzato, produce file in formato html, epub, ecc. e che possono essere importati nel servizio.

es: Animation Nodes Manual di Blender

Measuring Successful Documentation

Documentation as code

How a searchable knowledge management system helped Dropbox reuse knowledge and work more effectively

How to Write an Awesome Readme

Writing multi-language documentation using Sphinx

Sphinx & Read the Docs

Add new comment

Your name

The content of this field is kept private and will not be shown publicly.

Homepage

Comment

About text formats

Text format

Full HTML 2

Web page addresses and email addresses turn into links automatically.
Lines and paragraphs break automatically.

Filtered HTML

Web page addresses and email addresses turn into links automatically.
Allowed HTML tags: <a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type='1 A I'> <li> <dl> <dt> <dd> <h2 id='jump-*'> <h3 id> <h4 id> <h5 id> <h6 id>
Lines and paragraphs break automatically.

CAPTCHA

This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.