Jump to content

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


Recommended Posts

Posted

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.

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
×
×
  • Create New...