ivorygates: (GEN WIKIPEDIA)
[personal profile] ivorygates
Now that we're in Open Beta, we're getting to see how actual people who aren’t us are using the site, and this is letting us know how we need to revise our documentation and, of course, write more.

One of the things we're viewing with enthusiasm now that many of our tasks are no longer as time-critical is the opportunity to allow many more people to participate in our process. In the past several months, a lot of people have wanted to get involved in site documentation, but there were a number of reasons we couldn't accept all the help that was offered.

We have now remedied that small problem.

The new community [site community profile] dw_docs_training is intended as a dedicated work and training environment for new volunteers, experienced members of the docs team, and for anyone who's working on related aspects of the GUI, such as the site copy team and the site styles team. [site community profile] dw_docs_training will be a closed, moderated, response-screened community so we can concentrate on the training and support aspects of docs writing.

In [site community profile] dw_docs_training, we'll expect you to write material off a supplied prompt and we'll the result in the community for critique. To ensure the critiquing process remains useful and focused, your sample exercises will be re-posted by one of the community moderators, and all comments will be unscreened at the same time, and only when everybody who needs to comment on the entry has commented.

Your material will be judged by three criteria: accuracy (does the site behave in the fashion you indicate?), clarity (can an inexperienced or confused reader understand what you've written and follow any directions included?) and conformity with the Dreamwidth style as laid out in the Manual of Style.

If you are participating in the community as a proofreader or copyeditor, the procedure you'll follow will be similar, except you won't be posting entries, you'll be commenting on the entries of others.

In addition to participating in [site community profile] dw_docs_training, all volunteers in training will be expected to read all of the FAQs. Not only will this give you a broad familiarity with the documentation, there are many places in which it hasn't yet reached perfection: this will be your chance to see if you can find errors.

You'll also need to familiarize yourself thoroughly with the Dreamwidth Manual of Style and the Dreamwidth Site Terminology, both of which can be found on the Dreamwidth Wiki.

The Dreamwidth Manual of Style:

The Dreamwidth Terminology Notes:

What we want out of this process, and we hope you want it too, is for you to be able to write a FAQ or other piece of site copy to site standard language, or (if you aren't one of our writers) to be able to review a piece of site copy, detect typos and other problems, identify those areas in which it does not meet the Dreamwidth standard, and prepare useful revision notes for its author.

We'll be posting the details of how to apply to the Docs Team here in [site community profile] dw_docs very soon.
baggyeyes: Mac-Keyboard (Keyboard)
[personal profile] baggyeyes

I took a look at the FAQ (What are Paid Accounts?), and there wasn't anything about it on the table. I know both Live Journal and Insane Journal's Free accounts have disabled customized comment pages. I just want to know if that will be the same here, and is it documented anywhere, particularly in the FAQ?
piranha: red origami crane (Default)
[personal profile] piranha
dear FAQ-team --

http://www.dreamwidth.org/support/faqbrowse.bml?faqid=98 should contain a mention that we do not permit crossposting to communities.
smilingslightly: little brown bat perched on her finger (Default)
[personal profile] smilingslightly
Hey guys,

I'd anticipated that advanced customization wasn't going to be available for free/basic accounts and was surprised that it not only was still around after the start of Open Beta but that the "What are paid accounts?" FAQ made no mention of it. Now I'm hearing that it is indeed turned off. So might the account levels FAQ be changed to reflect that? Some sort of general announcement might be good, too, because a lot of people are confused. (Especially the people who were in the middle of making changes on their basic accounts when advanced customization went away.)
[personal profile] rho
I have been neglecting you. Have kept having various things that I've meant to post here, but somehow never managed to find the time to be posting them. This is the result.

1. Site copy people! We have a fan! I received this in an email the other day:
I've just spontaneously squee'd at rah about the DW site copy and she says
you're the person to pass it along to. So forgive me if I become a little
incoherent here: god, I *love* it. Love it, love it, *love* it. *Wow* do I
love it. I click around to hunt something down and I wind up on a page
that's got information, it's got useful information, it's got clear
information, it sounds like it was written by a human being, and a helpful
and *knowledgeable* human being. (Also, and I've only just begun to
realize how hard this in particular must be to achieve, it doesn't make my
question sound dumb, and it doesn't make it sound like it'll be hard to do
whatever task it is I'm trying to do.)

It's, um, possible I may have clicked on a few links I didn't need just so
I could read a little more. Um, you know. As one does.


I know what we do can often be frustrating because it feels as if we're just invisibly moving things about in the background, with nobody ever noticing us or thanking us, so I thought I'd pass this on to you (with permission) in the hope that you all get as much of a kick out of it as I did. We're doing a kick-ass job, and I'm proud of what we've accomplished.

2. FAQ editors, if at any point you see a FAQ that we don't have yet but that you think we need, but that doesn't really seem to fit into any of the existing categories, please throw up a quick and dirty FAQ in the misc category, and then we can polish and categorise later, depending on what ends up there.

3. When you need to reference an example domain in any site text or documentation, use example.com, which is set aside specifically for the purpose. I've seen one or two people using website.tld, which I'd rather avoid because I don't think that's as obvious to non-technical people.

4. When we first went into closed beta, I decided that I'd keep membership here open, since the only people coming in at the start of closed beta would be people working on the site. We're now well into the stage of accepting users, and open beta is almost upon us. However, we've had a bunch of people join the comm and absolutely no problems so far, so I'm going to keep membership open for now, and revisit in the future if we do have any problems.

5. I'm lousy at tagging. 9 times out of 10, I forget to tag an entry, and on the tenth time, I can never figure out what tag to use. I've opened up tagging to all community members. If someone wants to go back through old posts, tag them, and come up with a coherent tagging system, I'd very much appreciate it. Once we have a robust tagging system in place, I'll probably restrict the creation of new tags down to community admins.

6. I'm fairly sure I had something else I meant to say, but I can't remember it. If I end up posting another entry in 2 hours, then I apologise.
denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)
[staff profile] denise
FAQ people! I have been shockingly neglectful of you, because [personal profile] rho has things well in hand, but: is there anything anyone still needs answers to?
[personal profile] rho
Please sit down and take out your paper bags to breathe into before reading any further. You just might need them.

It's April 2 today, which means that we have exactly four weeks until open beta and four weeks to get our FAQs and guides into a state suitable for open beta consumption. There are already a lot of people asking questions, and I'm seeing our FAQs getting linked to in the wild, so I want to try to make sure we have some awesome documentation before open beta launch.

Ideally, I'd like to try to get everything finished up at least a week in advance (ie, by the 23rd) to give us time for proof reading, testing, checking for accessibility and so on. If we aim to finish early, that also gives us a little bit of wiggle room for when things inevitably run over a little. This gives us three weeks.

I'd appreciate it if everyone on the userdoc team (those of you writing FAQs and guides) could either comment here or email me to let me know what you're working on, how you're getting on with it, whether you're going to be able to finish on time or whether you'll need help, and whether you'll be able to take on additional tasks after you've finished what you're doing at the moment.

If you al can do that for me, that will let me plan out our final push to the finish line.
greg: Fantasy scene with silhouette of a castle, with a small handwritten note saying "lost in a dream" superimposed. (Default)
[personal profile] greg
Might it be useful to create a "What are communities?" FAQ? I've seen it happen (on LJ at least) that people are told "you want to post your $foo in a community, etc. etc." - people that are new to DW will not know what communities are or why they're different from personal journals (or even that they're different, maybe.)

I'm not exactly volunteering for it, just wanted to throw it out as a suggestion.
pauamma: Cartooney crab holding drink (Default)
[personal profile] pauamma
Bug 566 may cause momentary instability in FAQ storage and display. You should make sure to make copies of your FAQs (and of your changes) outside Dreamwidth until further notice.

ETA: When the patches are reviewed, I (or whoever beats me to it) will check with rho before committing them.
[personal profile] rho
I mentioned this briefly on IRC, and nobody seemed to think it was a horrible idea. I've just created a new FAQ category, "tracking" which will, obviously, cover tracking and the inbox. I figured there were enough different issues surrounding this that it probably deserved its own category. Exactly what's going to go in and who's going to fill it is still to be determined.

FAQ titles

Feb. 22nd, 2009 06:36 pm
[personal profile] rho
One thing I've noticed in looking at the FAQs that you guys have written is that you seem to be going with the LJ style for the titles/questions in the FAQ, using two-part questions like "What is Quick Reply? How do I turn Quick Reply on or off?" and "What does my profile contain? Who can see the information on it?"

I'm not totally committed to this, and will happily change my mind if you disagree with me, but I've never really been much of a fan of this sort of naming. My general feeling is that if possible, we should try to have all the questions just be simple single questions, and that if that isn't possible, we should consider splitting up into two different FAQs.

What do you guys think?


dw_docs: Dreamwidth d logo, with text "dw_docs" (Default)
Dreamwidth Documentation

September 2016

25262728 2930 


RSS Atom

Most Popular Tags

Style Credit

Expand Cut Tags

No cut tags
Page generated Sep. 19th, 2017 01:34 pm
Powered by Dreamwidth Studios