[bglug] Documentazione per progetti php

[Steevie]

Ciao,

2016-11-18 10:12 GMT+01:00 Roberto Santini <roberto.santini89@gmail.com>:
> Ciao a tutti, ho ultimato da alcuni giorni una applicazione realizzata con
> php e Laravel. Vorrei ora realizzare la documentazione per l'utente finale,
> non per lo sviluppatore a cui interessa la documentazione delle singole
> funzioni o api.
> Ho fatto un po di ricerche, ho trovato molte soluzioni ma solo per
> documentazione "tecnica", o almeno a me pare così.
> C'è una soluzione, anche open, che possa fare al caso mio o devo ricorrere a
> delle semplici pagine html? Ho pensato anche alla soluzione wiki, ma non
> credo che sia la cosa ottimale.
Risposta breve:
Dipende da quale formato vuoi fornire agli utenti finali.

Più in dettaglio, io per diversi anni ho usato python-sphinx [1] per
produrre documentazione (in particolare un manuale utente) sia in
formato html che pdf (via Latex). Sphinx supporta molti altri formati
(epub, man, info, singlehtml ecc), ma non li ho mai provati.

Molto simili come idea sono altri linguaggi di markup come asciidoc
[2] o markdown [3] (solo output in html però), che sono sulla mia TODO
list.

HTH,
Stefano

[1] http://www.sphinx-doc.org/
[2] http://www.asciidoc.org
[3] http://daringfireball.net/projects/markdown/
-- 
Stefano David, PhD