Difference between revisions of "Documentation/Pending Tasks"

From Dreamwidth Notes
Jump to: navigation, search
Line 1: Line 1:
==Before we get started==
+
Documentation tasks that need doing!
  
Administrative type stuff that needs to get done first.
+
==FAQs==
 +
* Expand User Icons FAQ category -- <dwuser>batdina</dwuser>
 +
* Add expanding comments to the list on FAQ 4
 +
* Add a "how do I leave a community" FAQ
 +
* Add number of tags available to different account levels to FAQ 23
 +
* Create new FAQ for how much paid accounts cost, split out this info from FAQ 4, and link to the new one from there instead.
 +
* Document custom comment pages as per [http://dw-docs.dreamwidth.org/20719.html]
  
* [http://bugs.dwscoalition.org/show_bug.cgi?id=85 Contributor License Agreement]: Everyone who's going to be writing or editing documentation or site copy of any sort needs to sign one of these and return it to [[user:Rahaeli|Denise]] before they can do so.
+
==Guides==
 +
* Relationships Guide -- <dwuser>snakeling</dwuser>
 +
* Newbie Guide -- <dwuser>liv</dwuser>
  
* '''FAQ categories''': We need to decide what the overall structure of the FAQ is going to be. What categories are we going to have? How are we going to order them? -- '''done!'''[http://www.stage2.dreamwidth.org/support/faq.bml]
+
==Site Copy==
 +
* create.bml needs a "would you like to create a community instead" option
 +
* Clarify the "mutual" options at the bottom of the manage profile page to be less confusing.
 +
* Expand on the OpenID page to try to be less confusing [http://caramel-betty.livejournal.com/147145.html]
  
* [[Documentation related zilla items|Zilla items]]: These include minor updates to the FAQ and translation system. Ideally, we don't want to start writing anything until these updates are in place.
+
==Copy Editing==
  
* '''Guide to the FAQ and translation systems''': It would be nice if someone who is familiar with these from working with them on LJ could write up a guide to using them for our volunteers who will be coming into this without any of that familiarity. -- '''half done!''' [[FAQ backend guide]]. Still need a translation system guide.
 
 
* [[Consistency in naming]] and [[Terminology]] ([[Talk:terminology|talk page]]): We need to decide what we're calling everything before we start writing about them! -- '''mostly done!''' but check the pages for ongoing discussions.
 
 
* '''Mock up design for guides''': With guides especially, we want consistency in appearance, especially since we're incorporating back/forward/top navigation which we'll be applying manually. Ideally, we should find someone with design skills and ask them to help create a consistent and non-ugly look for these (within the confines of the FAQ system. Possibly consider simple graphics for the navigation? -- <ljuser>gameboyguy13</ljuser> is working on this.
 
 
* [[Guides ideas]]: We need to decide which guides we want to write, and -- more importantly at this point -- which ones should be our priority to get done before open beta launch.
 
 
==Before open beta==
 
 
The first stages of actually writing stuff.
 
 
* '''FAQ''': We want to have the broad skeleton of categories in place, together with answers to basic questions, at least.
 
 
* '''Guides''': We want to get some of the most important guides written early.
 
 
* '''Knowledge bases''': None of these need to be written at this point.
 
 
* '''Site copy''': We want to get all of this rewritten at this stage.
 
 
* '''Copy editing''': All site copy and user documentation written in this stage needs to be proof read as wel.
 
 
==Long term==
 
 
Everything that can wait until after we're launched.
 
 
* '''All other documentation'''
 
 
* '''Complete overhaul of doc back end'''
 
  
 
[[Category:documentation]]
 
[[Category:documentation]]

Revision as of 18:45, 8 May 2009

Documentation tasks that need doing!

FAQs

  • Expand User Icons FAQ category -- [info]batdina
  • Add expanding comments to the list on FAQ 4
  • Add a "how do I leave a community" FAQ
  • Add number of tags available to different account levels to FAQ 23
  • Create new FAQ for how much paid accounts cost, split out this info from FAQ 4, and link to the new one from there instead.
  • Document custom comment pages as per [1]

Guides

Site Copy

  • create.bml needs a "would you like to create a community instead" option
  • Clarify the "mutual" options at the bottom of the manage profile page to be less confusing.
  • Expand on the OpenID page to try to be less confusing [2]

Copy Editing