[mythtv-users] Help with documentation

Hika van den Hoven hikavdh at gmail.com
Sun Jun 21 11:25:12 UTC 2015


Hoi Hika,

Sunday, June 21, 2015, 12:55:59 PM, you wrote:

> Hoi Paul,

> Sunday, June 21, 2015, 12:01:20 PM, you wrote:

>> Are there any users who would be willing to help bring our documentation
>> up to date?

>> Developers are in general very  bad at documentation which is why we 
>> really need some help from someone who has the aptitude for this sort of
>> thing to help us maintain it. It could be one individual or like the 
>> translation teams it could be a group of people working together which
>> seems to work well at least for the translations.

>> The main documentation is now in the wiki here 
>> https://www.mythtv.org/wiki/MythTV-HOWTO but it is a little out of date.
>> We are also thinking of the idea to add some context help within Myth 
>> using the built in web browser widget so for each screen we would need
>> some help text detailing what the screen does and what options are 
>> available etc.

>> Paul H.
>> _______________________________________________

> That's a huge thing you're asking. The wiki might be a little out of
> date but it also needs restructuring, with better ways of finding what
> you're looking for.
> Are you talking 0.27 or 0.28. Because the latter means you need a
> working 0.28 installation.
> What is the support the devs are offering to such a team? Because I
> think it's to big for someone alone.

Thinking further, I think the first step would be to decide on a fresh
structure and then creating a new wiki in parallel, moving over stuff
step by step.
A first thought is to create an extensive tree of keywords, whereby
assigning every page the appropriate keywords. So much more extensive
then the present search tree. Also several lines of entry, like to
start with: initial configuration, maintenance, upgrading, api-usage
etc.
Also to start with if you create such a framework, a good
documentation for anybody wanting to add or update. 

Tot mails,
  Hika                            mailto:hikavdh at gmail.com

"Zonder hoop kun je niet leven
Zonder leven is er geen hoop
Het eeuwige dilemma
Zeker als je hoop moet vernietigen om te kunnen overleven!"

De lerende Mens



More information about the mythtv-users mailing list