Miglior formato per il documento di progettazione? [chiuso]

Per un progetto open source, consiglierei di non fare affidamento su un formato proprietario ristretto (cioè senza docx).

Nella vita del progetto, il documento si evolverà sicuramente (immagina la versione 3.0!). Quindi suggerirei di non usare formati che rendono difficile la manutenzione (ad esempio non PDF, poiché è più per la distribuzione / archiviazione che per la modifica).

Se desideri che una parte più ampia della comunità legga facilmente il file e contribuisca, eviterei anche i formati esotici che richiedono la ricerca di strumenti di terze parti rari (ad esempio, non Latex, a meno che tu non scelga principalmente una popolazione di ricercatori scientifici)

I miei suggerimenti in ordine di preferenza:

• testo grezzo à readme.txt - unicode fornisce molti simboli ora e le formule potrebbero essere espresse in modo funzionale. Sfortunatamente dovrai evitare questa opzione perché non c'è modo di inserire diagrammi / immagini.
• markdown - più semplice di HTML - è possibile inserire schemi - una presentazione più pulita rispetto al testo non elaborato. Inoltre, servizi come github visualizzano in modo nativo questo formato, il che lo rende una buona scelta per l'open source. Non ti lascia scegliere la composizione. Purtroppo non supporta ancora MathML , quindi dovresti esprimere le formule in modo funzionale.
• OpenDocument (aka .odt) - potente, standardizzato (ISO), include il supporto per le formule matematiche, ampiamente supportato e utilizzato - in modo definitivo una buona scelta.

Anche l'HTML potrebbe essere un'opzione, con il MathML per le formule. Tuttavia, penso che per un autore sia meno conveniente da usare, in modo che il saldo sia favorevole a uno dei precedenti.

Non mi piace né docx (perché è un formato proprietario) né html (perché di solito finisce con un sacco di file con il lettore che non sa da dove iniziare.

pdf è un buon formato per distribuire documentazione (Forse creato usando LaTex), i puri file di testo funzionano bene. Il software matematico, tuttavia, potrebbe implicare formule e immagini che non funzionano molto bene nei file di testo.

Se si desidera ottenere un formato di documento modificabile che supporti formule e grafica incorporata, sceglierei il formato di testo .odt che è compreso dalla maggior parte dei moderni software di elaborazione testi, inclusi MS Office e Open / Libre Office.

Potresti anche usare un wiki, o sfinge per documentare i tuoi disegni. Personalmente uso la sfinge, posso ottenere l'evidenziazione della sintassi del codice, matematica, tabelle, figure, hyperlinking e molto altro. Ha anche il vantaggio di essere in grado di inserirlo automaticamente in html, pdf, epub e molti altri formati.

Inoltre, a seconda del linguaggio di programmazione che stai utilizzando, potresti utilizzare un blocco note jupyter che consente a testo e codice di creare un documento potente.

Uso spesso OneNote, la versione base è gratuita. È come Word, ma puoi incorporare i file. Non è necessario salvare ogni pezzo di documentazione come un singolo file e ordinarli in cartelle, è possibile ordinarli in registri e pagine. In questo modo hai solo un file. Ha anche alcune funzionalità dell'HTML, è possibile collegare ogni pagina di OneNote a un'altra. Anche le formule e le immagini funzionano bene.

Il problema è che hai bisogno di OS X o di Windows perché non c'è altro visualizzatore per altri sistemi operativi.

Il formato è proprietario e ciò lo rende ancora peggio.

Ma il formato migliore è più un'opinione personale e se tu o i tuoi potenziali spettatori del documento non possiedi OneNote, allora questo è il formato peggiore.

Considera l'uso del lattice. Ci sono applicazioni open source per OS X, Windows e Linux.