Jump to content

I'm late for the party, but I'd like to make a User Guide

glitch head

Recommended Posts

ciao there,

my sammichFM and i decided to intensify our relationship. for that i need a book, i love sitting in my studio (corner) and having a printed manuals available. i also have some questions that i'd seek answers for in the process.

so my idea is to compile all the usage related information around to a restructuredText convolute that can then be transformed to HTML, PDF (for printing onto paper) and other formats with Sphinx. i know both well enough to consider them feasible for the task. the compilation would include:

  • the contents of the project decription
  • as well as these from the online manual
    • possibly extended with SammichM related specifics
  • the contents of the software source's doc folder as appendixes
  • maybe a few HowTos that describe common workflows

i'm interested in any feedback regarding this idea.

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Create New...