Difference between revisions of "Talk:ISFDB Editing Guide"

From ISFDB
Jump to navigation Jump to search
 
(Help by tool vs. help by task)
Line 13: Line 13:
  
 
[[User:Alvonruff|Alvonruff]] 10:29, 17 Jun 2006 (CDT)
 
[[User:Alvonruff|Alvonruff]] 10:29, 17 Jun 2006 (CDT)
 +
 +
:To rephrase what you're saying, there are two ways to organize the help; by tool and by task.  Perhaps both belong here on or under the Editing Guide; or maybe one belongs in Help instead.  I'll start trying to assemble some of this material and we can work out where to put it as we write it. [[User:Mike Christie|Mike Christie]] 19:45, 17 Jun 2006 (CDT)

Revision as of 20:45, 17 June 2006

This page should give general background people need before editing. The individual articles that fork off from here should be focused on a particular application (like editpub.cgi), so that particular application can have a help link embedded in it, which will refer back to an appropriate wiki page. The individual wiki pages probably need to have a link back to this page, since someone may go through this process:

  1. They're looking at a particular publication, and notice an error.
  2. They think "Hey - what's this edit link do"?
  3. They see a big form and aren't sure what to do. They click on "Help".
  4. The help wiki page obviously has a lot of data, but contains a message at the top of the page, that says "read me first before continuing".
  5. They click that, and they get here. They presumable read the overview. (They won't, but let's presume they will).

There may be the need for separate howto's, which describe the multiple steps needed to accomplish some editing tasks. For instance, when adding a magazine, the rough order of steps are:

  1. Enter the magazine via "Add Magazine".
  2. If a wiki page exists for that magazine, add the issue to the wiki page (see guidelines for editing a magazine wiki page).
  3. If a wiki page does not exist, make one (see guidelines), and add the new article to the main magazine page (see guidlines).
  4. Optional followup: Scan titles in the magazine for known series, and fix those titles up. Merge the editor's individual editor citations into a single annual citation.

Alvonruff 10:29, 17 Jun 2006 (CDT)

To rephrase what you're saying, there are two ways to organize the help; by tool and by task. Perhaps both belong here on or under the Editing Guide; or maybe one belongs in Help instead. I'll start trying to assemble some of this material and we can work out where to put it as we write it. Mike Christie 19:45, 17 Jun 2006 (CDT)