denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)
Denise ([staff profile] denise) wrote in [site community profile] dw_docs2012-02-02 02:51 pm

filing bugs for needed FAQ updates

The perpetual bane of any product is making sure the documentation is up to date. We've been falling down on documentation for a while, and there are lots of reasons for that but I'd once again like to start trying to change it. Now that it's a new year, it's time to once again start in on a concerted effort to figure out what's missing from the FAQs (and then, of course, work to fix that, but the first step is identifying the scope of the problem!)

I have a few people working off the code tours to identify what we've added that needs to be documented, but consider this an open invitation to join them. If there's something you identify as missing from the FAQ, please open a bug for it (or if you don't want to navigate Bugzilla, you can just leave a comment here and someone will move it into Bugzilla for you).

See Bugzilla: How to enter, find and work on docs bugs for reference, and the list of open docs bugs to see what's already been reported.
insignia: (Default)


[personal profile] insignia 2012-02-03 12:27 am (UTC)(link)
The FAQ says that "All notifications will automatically be sent to your inbox." However, some notifications are only sent to your e-mail address. Perhaps changing "all" to "most" would be a good idea, to avoid confusion.
inoru_no_hoshi: The most ridiculous chandelier ever: shaped like a penis. Text: Sparklepeen. (Default)

Re: Notifications

[personal profile] inoru_no_hoshi 2012-02-03 01:24 am (UTC)(link)
I noticed this - hunted down pertinent FAQ and filed a bug! Thank you. :D
rike_tikki_tavi: cuddle pile of mongooses (Default)

[personal profile] rike_tikki_tavi 2012-02-03 06:57 pm (UTC)(link)
So I'd like to try and help. Found an easy bug to work on (actually the one reported above) and I have one question. Lots of the FAQs include links. Should we just ignore those when writing a new/revised FAQ text or what should we do?
rike_tikki_tavi: cuddle pile of mongooses (Default)

[personal profile] rike_tikki_tavi 2012-02-03 08:16 pm (UTC)(link)
Ok, I explained that badly. In the FAQ I want to amend is a link to the FAQ for the inbox. But since I thought we should write our docs as txt files I'm not sure how to incorporate the link. Should I write the html for the link in brackets behind the word that will be the link or is there another rule for this?

Re the CLA, I've already downloaded the pdf but I'll have to wait till Monday to get it to you. I'll have to print and scan it at work since I don't have a printer/scanner at home.
rike_tikki_tavi: cuddle pile of mongooses (Default)

[personal profile] rike_tikki_tavi 2012-02-03 08:27 pm (UTC)(link)
That's exactly what I wanted to know. Thanks for your fast answer.
adannu: (Default)

[personal profile] adannu 2012-02-04 10:06 pm (UTC)(link)
Ooh. I've been thinking about volunteering for this and was wondering how/where to get started so yay. :D