[wp-docs] Task based documentation
mikea at turbonet.com
Wed Mar 9 02:43:54 GMT 2005
I've thought about this a bit over the past few days and really agree
with Morgan. In particular, it will be difficult to convince me that
[[USER:MDAWaffe/Administration Panels]] etc. are not useful in their
It may be possible to argue that Task Based docs are overall more
useful, but it seems to me Tour (as Morgan aptly puts it) docs are
necessary as well. Documentation needs to come from both sides:
Alice asks "Can I make a particular Link not appear on my Links list?"
Bob points at his screen and asks "Links -> Add Link / Advanced:
Visible radio button. What does that mean and what does it let me do?"
It's really the same question asked from two different ends. Both get
asked, and both need to be addressed. But knowing one question does
not mean you know how to ask the other. Including documentation like
[[Administration Panels]] is therefore necessary. Where it should _go_
and under what title (even ignoring the Panel nomenclature issue) are
important questions, though. Especially since it'd be nice not to
duplicate information much (redundant and twice as hard to update).
Perhaps [[A Tour Through WordPress Administration|Administration
Panels]] would be an appropriate link from [[Administering your blog]].
Please comment, critique, lambast or whatever else.
On Feb 21, 2005, at 1:13 PM, Morgan Doocy wrote:
> I agree that task-based articles are more frequently used. However, it
> is also worth noting that any good reference book on an application
> with a UI will have sections which simply describe the UI and give
> only general overviews on how to use it, and I think we would be
> remiss to exclude that from the Codex. It is also worth noting that
> task-based instructions need to be updated just as much as the more
> expository "tour" articles as the software evolves. It's my opinion
> that both are essential to a reference, even though instructions are
> the more frequently used.
> On Feb 21, 2005, at 12:31 AM, Matthew Mullenweg wrote:
>> Since we have this list back, let me emphasis that the best sort of
>> thing for the codex is *task-based* documentation not
>> structure-based. Task-based docs survive changes in the application
>> better (menu items may move around a lot) and matches more how people
>> use software.
>> Matt Mullenweg
>> http://photomatt.net | http://wordpress.org
>> http://pingomatic.com | http://cnet.com
More information about the wp-docs