Difference between revisions of "Documentation suggestions"

From MythTV Official Wiki
Jump to: navigation, search
(What needs te be worked on in the manual)
 
Line 1: Line 1:
 +
Below you'll find a summary of things that needs to be done in this manual.
  
===Need to add a quickstart chapter===
+
====quickstart chapter====
quickstart chapter needs to be added to tell the reader what to read/not to read when you just want to get mythTV up and running. e.g. a short description how to quickly walk through the manual without te need to read to much.  
+
quickstart chapter needs to be added to tell the reader what to read/not to read when you just want to get mythTV up and running. e.g. could be a short description how to quickly walk through the manual without te need to read to much. This works better than a sepparate chapter with redundant data because this needs te be maintained and the reader can beter find surrounding information about an quickstart topic.
  
 
installing > configuring > using
 
installing > configuring > using
Line 7: Line 8:
 
of course someone who needs to setup a dvb-s device does not need to read the chapter about analogue cards. Both do need to read the chapter about setting up capture cards in general. this needs to be  
 
of course someone who needs to setup a dvb-s device does not need to read the chapter about analogue cards. Both do need to read the chapter about setting up capture cards in general. this needs to be  
  
===Add reading signs ===
+
====Add reading signs ====
 
need to add reader signs to chapters and paragraphs so a reader knows if he needs to read it. Need to add the following reading signs:
 
need to add reader signs to chapters and paragraphs so a reader knows if he needs to read it. Need to add the following reading signs:
 
* no mark:  
 
* no mark:  
 
* Information: nice to know but not necessary for setting up/working with MythTV
 
* Information: nice to know but not necessary for setting up/working with MythTV
 
* Advanced: not for beginning MythTV users
 
* Advanced: not for beginning MythTV users
 +
* QuickStart: Chapter of paragraph is part of the quickstart guide.
  
  
===The chapter about DVB-C needs work ===
+
====The chapter about DVB-C needs work ====
 +
The title says it all.
  
===The chapter about DVB-T needs work ===
+
====The chapter about DVB-T needs work ====
 +
The title says it all.
  
===The chapter about IP-TV needs work ===
+
====The chapter about IP-TV needs work ====
 +
The title says it all.

Revision as of 12:24, 5 September 2008

Below you'll find a summary of things that needs to be done in this manual.

quickstart chapter

quickstart chapter needs to be added to tell the reader what to read/not to read when you just want to get mythTV up and running. e.g. could be a short description how to quickly walk through the manual without te need to read to much. This works better than a sepparate chapter with redundant data because this needs te be maintained and the reader can beter find surrounding information about an quickstart topic.

installing > configuring > using

of course someone who needs to setup a dvb-s device does not need to read the chapter about analogue cards. Both do need to read the chapter about setting up capture cards in general. this needs to be

Add reading signs

need to add reader signs to chapters and paragraphs so a reader knows if he needs to read it. Need to add the following reading signs:

  • no mark:
  • Information: nice to know but not necessary for setting up/working with MythTV
  • Advanced: not for beginning MythTV users
  • QuickStart: Chapter of paragraph is part of the quickstart guide.


The chapter about DVB-C needs work

The title says it all.

The chapter about DVB-T needs work

The title says it all.

The chapter about IP-TV needs work

The title says it all.