welcome: please sign in

Diff for "RewriteGoals"

Differences between revisions 7 and 8
Revision 7 as of 2007-10-20 18:10:07
Size: 1785
Editor: MichaelOlson
Comment: Add style guide sectoin
Revision 8 as of 2007-10-24 23:37:38
Size: 2199
Editor: MichaelOlson
Comment: Add PagesNeedingLove link, mention section numbers
Deletions are marked like this. Additions are marked like this.
Line 35: Line 35:
=== Style === === Section numbers ===

If the page is the main page, or exactly one degree away from it, then you should include the following text at the very top of the page, which turns off numbering of headings. This may be used on other pages at the discretion of those who keep the wiki up-to-date.

{{{
#pragma section-numbers off
}}}

=== Writing style ===
Line 45: Line 53:
If you want to have charge of a particular page or topic, please indicate this below. If you want to help out with a particular page or topic, please indicate this below.
Line 53: Line 61:
 * Pages need to be deleted -- see RewriteGoals/PagesToDelete

We have just started.
 * RewriteGoals/PagesToDelete: Pages that need to be deleted.
 * RewriteGoals/PagesNeedingLove: Pages that need some attention, but should not be deleted.

This page describes the effort to bring the wiki up-to-date with respect to the new setup.

TableOfContents

1. Context

The information on this wiki needs to be made accurate with the current setup (deleuze, mire, abulafia, etc.).

This involves:

  • Updating information on existing pages
  • Deleting pages that have no useful content
  • Make it easy for members to get up-to-speed on migration,
    • Re-work WelcomePage to be more relevant and easy to browse

    • Provide more examples on ["DomTool/Examples"] and on MigrationTips

  • Making an HCoop "Member Manual", perhaps by using MemberManual for the start page, with chapters represented as subpages

  • Making a migration FAQ that answers all questions that members are likely to have during migration

2. Style guide

2.1. Template

Here's a basic template to apply when making new pages and revising old ones.

Description of page.  I.e.: This page describes how to filter your email using
procmail and Exim.

## Every page should have a table of contents
[[TableOfContents]]

Remaining content of page, split into logical sections.

2.2. Section numbers

If the page is the main page, or exactly one degree away from it, then you should include the following text at the very top of the page, which turns off numbering of headings. This may be used on other pages at the discretion of those who keep the wiki up-to-date.

#pragma section-numbers off

2.3. Writing style

It would probably be best to use "you" (second-person) when writing the MemberManual.

The AdminManual (basically just a re-org of NewServerSetup) should be in third-person.

3. Personnel

MichaelOlson is in charge of this effort.

If you want to help out with a particular page or topic, please indicate this below.

Name

Pages / topics

RyanMikulovsky

Parts of Non-technical administrative stuff?

MichaelPotter

Basic account usage

4. Progress

RewriteGoals (last edited 2008-07-07 04:28:00 by localhost)