pauamma: Cartooney crab wearing hot pink and acid green facemask holding drink with straw (Default)
Res facta quae tamen fingi potuit ([personal profile] pauamma) wrote in [site community profile] dw_wiki2011-10-08 05:41 pm
Entry tags:

A question of nomenclature

So I've been writing and or uodating a series of wiki pages(*), often in pairs for setting up foo and using foo in your code. Titles so far follow the "Setting up Foo" (which may also covers installing, starting/stopping, and troubleshooting) and "Foo" (which covers up writing code for or using in Dreamwidth code).But now, I'm wondering whether that's the best nomenclature and considering renaming "Foo" pages to "Using Foo in code" or something similar. I don't think it's worth having an extra Foo page for that, as it would just link to both and have little content of its own. However, that makes it hard to link to both, when you don't know what information the reader is most likely to want. So I'm considering using [[Category: Foo|Foo]] instead, for those links. What do you guys think?

(*) So far, TheSchwartz is done, Gearman is next (haven't started), and when I'm done I may do Memcache and MogileFS.
mark: A photo of Mark kneeling on top of the Taal Volcano in the Philippines. It was a long hike. (Default)

[staff profile] mark 2011-10-10 01:20 am (UTC)(link)
I don't have a horse in this race, but since you're asking:

I'd suggest "Foo" is an index page that has things like "How to set Foo up" and "Using Foo in your code" as links. You then define those pages and you can have very specific information there. The generic "Foo" page is useful to have basic information like "What is this?" and "What does it do?" and "Why do I need it?"
afuna: Cat under a blanket. Text: "Cats are just little people with Fur and Fangs" (Default)

[personal profile] afuna 2011-10-14 11:25 am (UTC)(link)
I think that "Foo" is better than "Using Foo in code", and that setting up foo can always be linked to from Foo by default.

Or what [staff profile] mark said!
Edited 2011-10-14 11:39 (UTC)