[mythtv-users] Myth Documentation, was: Please shut up!
beww at beww.org
Mon Jan 29 15:02:54 UTC 2007
On Jan 29, 2007, at 7:34 AM, Steven Adeff wrote:
> As for version'ing the wiki, and a note about this *should* exist on
> the home page, it is assumed on the wiki that unless the text says
> otherwise the information pertains to the currently released version.
> If upon the release of a new version the information becomes outdated
> it should be changed as soon as it is noticed, with the old
> information being dated to the previous release (so when 0.21 comes
> out, the information would say it pertains to 0.20).
So one problem is that, as Myth advances, it takes a large effort
just to keep the WiKi up to date. What you are saying is that a lot
of entries need to be edited every time a new version comes out,
"treading water" just to stay afloat.
And Myth is not the only moving target. The kernel, IVTV, LIRC,
OpenGL, nVidia drivers and a lot more all keep "improving".
So rather that "assuming" that an entry refers to the current
release, which virtually guarantees it will go stale without
continuing effort, what about some way to say "the following versions
were current at the time of this entry". That way a reader would know
immediately if the entry was current or not, without further work on
the part of the original creator.
Yes the entry should be "noticed" and "updated", but this is the real
world and it can take a long time for that to happen.
The only thing worse than no information is wrong information.
Maybe we need a "documenter's list" as opposed to a "users" or
"developer's" list. I know that's pretty far-fetched but I'm just
throwing out ideas.
More information about the mythtv-users