|
Size: 1428
Comment:
|
Size: 1785
Comment: Add style guide sectoin
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 19: | Line 19: |
| ''' We should probably have a style guide so that all volunteers are on the same page -- are there any good style guides avialable for wikis that we'd like to use? ''' -- RyanMikulovsky | == Style guide == === 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. }}} === 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. |
| Line 22: | Line 43: |
| MichaelOlson would like to be in charge of this effort. | MichaelOlson is in charge of this effort. |
This page describes the effort to bring the wiki up-to-date with respect to the new setup.
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. 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 have charge of a particular page or topic, please indicate this below.
Name |
Pages / topics |
Parts of Non-technical administrative stuff? |
|
Basic account usage |
4. Progress
Pages need to be deleted -- see RewriteGoals/PagesToDelete
We have just started.