Salutare,
Imi puteti sugera si mie cateva aplicatii in care pot crea documentatia unei platforme?
Un exemplu: https://app.keez.ro/, Crearea contului SmartBill Facturare - SmartBill Ajutor
Multumesc si scuze pentru deranj!
2 Likes
Practic vreau sa creez un manual de utilizare dar sa fie in varianta web.
testthedocs/awesome-docs: A curated list of awesome documentation tools (github.com)
Probabil cauti Site generators.
Docosaurus
Read the Docs: Documentation Simplified — Read the Docs user documentation 9.5.0 documentation
Gitbooks
2 Likes
Depinde si pentru cine faci documentatia. De exemplu eu folosesc intern formatul markdown pentru documentatii pe care le deschid cu o extensie pentru Google Chrome. Asta pentru ca in markdown poti face rapid documentatii complexe si nu iti bati capul prea mult iar la nevoie exporti in pdf. Daca insa faci o documentatie la un produs comercial sau de uz extern companiei probabil vei avea nevoie de ceva mult mai elaborat.
Avem o aplicatie WEB cu o multime de functionalitati, vreau sa prezint ce face aplicatia, fiecare buton, ce inseamna anumite optiuni, etc, o prezentare pe larg, iar intr-o anumita sectiuni cum faci cele mai uzuale actiuni, generare raport, setare alerte, etc.
Folosim Sphinx, uite aici Fleio Docs.
Ne gandin sa trecem pe MkDocs cu Material for MkDocs. Am folosi aici: IntoVPS Documentation.
Astea sunt pe ideea ca le tii intr-un Git repo si ai un proces de review de documentatie (cum faci la cod), linting, deploy staging/prod. Nu sunt CMS.
Docusaurus am vazut ca e fainut si cred ca e CMS-like.
In general, daca sapi un pic in HTML/JS/CSS vezi ce generator foloseste un site (daca nu e scris chiar in footer). De multe ori simplu, in meta generator sau comentarii, alta data identifici cum e ascuns din JS un “powered by”.
2 Likes
Mda, aparent Docusaurus nu e CMS, am incercat sa creez cu MkDocs si Sphinx dar imi e foarte greu…
poate incerci varianta aceasta
E o varianta simpla si friendly.
1 Like
Ce ai folosit din tot ce se afla in spreadsheet?
Nimic, le-am adunat ca referință. La momentul respectiv am făcut un plugin de wordpress că era până la urmă mai ușor de editat pentru client, l-am integrat în site, avea deja wp. Am făcut și o listă de wp documentation plugins (outdated) da nu m-au satisfăcut din diverse motive, ori nu făceau suficient, ori făceau prea multe / nu erau tocmai lightweight.
Mai recent mi-am făcut un sistem bazat pe gDocs - generează simplified html dintr-un folder de pe gDrive și reproduce structura de fișiere și headings.