[mythtv] RE: Documentation
nav.jagpal at gmail.com
Thu Feb 17 22:57:40 UTC 2005
Let me apologize if attaching files to emails on this list is inappropriate.
The last few months, part of my job has been to document the building,
configuring, maintenance of Windows 2003 servers - the documentation
that I had to write was almost step-by-step. It was intended for
people somewhat familiar with the Windows environment.
My intended audience for the MythTV user manual is the same audience -
people familiar with Windows. I assume these people can use web
browsers and CD writers etc. But I do not assume that they are
familiar with bash commands etc.
The document that I have attached is obviously only a sample of the
writing style for the document. I used XMLMind to create the DocBook
XML file. This way the look & feel can be changed for various purposes
(web, print outs, etc).
There is a ton of documentation on mythtv.info that I want to re-use
in this document. I believe that the documentation already available
on mythtv.org and mythtv.info is fairly comprehensive - but the
problem is that it tries to cover all situations/setups. I think we
are missing out on the audience that thinks "I just want a PVR. Tell
me how to make it! I'll find the parts you tell me to get, and install
the OS that you want me to install... "
Please send me comments/feedback. If someone can give me a reason why
such a document should not exist, please do not hesitate to let me
know. I'm not trying to make busy-work for myself - I just want to
give back to the community for such a great product.
If I have no objections, I will start to document the Debian
installation instructions in fairly great detail. I will have a box
beside me, and document the step-by-step installation.
Thanks in advance
On Thu, 17 Feb 2005 17:17:58 -0500, Jay R. Ashworth <jra at baylink.com> wrote:
> On Thu, Feb 17, 2005 at 12:14:00PM -0800, Nav Jagpal wrote:
> > However, I would like to start with user documentation. I'm sure there
> > is someone out there that would like to join the development process,
> > and what is a better way then documenting what is currently there.
> You bet.
> -- jr 'we're moving it soon, but don't let that stop you' a
> Jay R. Ashworth jra at baylink.com
> Designer Baylink RFC 2100
> Ashworth & Associates The Things I Think '87 e24
> St Petersburg FL USA http://baylink.pitas.com +1 727 647 1274
> If you can read this... thank a system adminstrator. Or two. --me
-------------- next part --------------
A non-text attachment was scrubbed...
Name: MythTV User Manual.xml
Size: 4366 bytes
Desc: not available
Url : http://mythtv.org/pipermail/mythtv-dev/attachments/20050217/4c9f1a51/MythTVUserManual.bin
More information about the mythtv-dev