Jak napisać stronę podręcznika?
Gdzie mogę znaleźć odniesienie do wszystkich kodów formatujących?
Czy są jakieś dobre tutoriale na temat pisania stron podręcznika?
Jaki jest najwygodniejszy sposób napisania strony podręcznika? Czy powinienem wpisać go bezpośrednio w edytorze tekstu? Czy są edytory WYSIWYG? A może powinienem napisać go w innym formacie, a następnie przekonwertować?
Jakie zasady powinna stosować dobra strona podręcznika?
documentation
amarillion
źródło
źródło
man man
,man groff
.Odpowiedzi:
Oto kilka stron internetowych, które pomogą Ci zacząć:
Kilka przydatnych narzędzi:
źródło
Istnieją narzędzia do pisania stron podręcznika, które omijają formatowanie troff. strony to mały, dobrze odgraniczony język i łatwy do celowania.
Dwa popularne narzędzia to:
yodl i zoem wydają się być inne formaty miły w tej przestrzeni.
Podsumowując, poleciłbym xmltoman, ponieważ jest to bardzo specyficzny dla strony dsl dsl, który poprowadzi cię ściśle.
źródło
Napisałem dość obszerny artykuł na blogu na ten temat, który można znaleźć tutaj:
źródło
Nie znam żadnych IDE ani samouczków, ale możesz zacząć od skopiowania istniejącej strony podręcznika i zmodyfikować ją zgodnie z własnymi potrzebami.
Aby zapoznać się z językiem groff z makrami MAN (który jest używany przez stronę man), odwiedź stronę man groff_man lub przeczytaj tutaj online
źródło
Spójrz na projekt Ronn . Jest to zniżka do generatora stron podręcznika. Może również generować strony podręcznika w formacie HTML, jak to .
Podoba mi się pomysł napisania całej dokumentacji oprogramowania w jednym formacie. Markdown IMO to dobry wybór
źródło