Development process improvement/Pages organization
From MediaWiki.org
 |
This page is currently a draft. Material may not yet be complete, information may presently be omitted, and certain parts of the content may be subject to radical, rapid alteration. More information pertaining to this may be available on the talk page. |
Contents |
[edit] Project policy
- Each time an engineering activity involves at least five engineer-days, a project page is created to document it, using the appropriate template.
- The project page has two main goals:
- It provides detailed information to stakeholders about the engineering department's activities, thus ensuring transparency and accountability. It also provides an entry point for people who want to get involved in a particular project.
- It is a way to keep track of all the documentation associated with a project (requirements, specifications, implementation plan, test plan, etc.)
- It is the responsibility of the engineering programs managers to make sure the project pages are created and kept up-to-date. The actual documentation should be delegated to managers, designers and engineers working on the project.
[edit] Requirements
Content
- greater emphasis on the two things people care about most: status and roadmap.
- One page that links to all of the other important docs
- No initialisms/acronyms in page titles.
- a conspicuous banner on top identifying it as a WMF project page, and not an extension/manual page.
- same banner should make it explicit whether the project is current or finished
- Project specifications, documentation, feature requests should be in subpages where possible.
Basic project information
- Project page template should have in infobox on the side with the following Project information:
- name
- team
- start and end dates
- category magic
Classification
- Per quarter categories (automatic using template dark magic if possible, to lower maintenance)
- Time-based category should appear only on main project page not on content subpages
- Categories with unambiguous names
- We should not rely on subpage convention for categorization: Make one category per project (which will appear on all pages)
Location
- All project pages on a single wiki
- Project pages go under main namespace, e.g. Article assessment, Liquid Threads
- But detailed documentation can be elsewhere, e.g. on wikitech:
Structure
- An index of some kind (or master category) for all pages
Maintenance
- As little maintenance as possible
Relation to extensions, subprojects & releases
- Different phases or a project, and subprojects, should be regarded as different projects
- e.g. We shouldn't have "Article feedback", "UploadWizard" or "Analytics upgrade", but "Article feedback pilot", "UploadWizard 0.1" and "udp2log deployment"
- Project page template should link to the extension's page, if it exists
Information:
- Group (features, general engineering, operations, fundraising, mobile, offline)
- Project title
- Project short description
- Link
- Status (+ date)
- Status history
- Roadmap, target date
- Team
- Program manager(s)
That's really all we need as far as tracking is concerned. The link can lead to a more detailed page (on mw.o or elsewhere, say, wikitech) with even more links if needed.
Places to display these pieces of information:
- Monthly reports
- Individual project pages
- Wikimedia engineering projects (formerly WMF Projects) (basically, the same as monthly reports, but formatted differently)
- ⇒ Information can be stored in a template and individual piece accessed through a #switch to be displayed appropriately
[edit] Community-led projects
It would be nice to record them somewhere; or even include them in the new structure?
[edit] Changes
[edit] Project categories
- Category:WMF Projects → Category:Wikimedia engineering projects
- Category:WMF Project Proposals → Category:Wikimedia engineering projects proposals
- Category:WMF Projects 2010q3 → Category:Wikimedia engineering projects active in 2010-Q3
- Category:WMF Projects 2010q4 → Category:Wikimedia engineering projects active in 2010-Q4
- Category:WMF Projects 2011q1 → Category:Wikimedia engineering projects active in 2011-Q1
- WMF Projects → Wikimedia engineering projects
[edit] Engineering reports
Done
- Put them all in Category:Wikimedia engineering reports
- WMF Engineering Overview October 2010 → Wikimedia engineering report/2010/September
- WMF Engineering Overview November 2010 → Wikimedia engineering report/2010/October
- WMF Engineering Overview December 2010 → Wikimedia engineering report/2010/November
- WMF Engineering Overview January 2011 → Wikimedia engineering report/2010/December
- WMF Engineering Overview February 2011 → Wikimedia engineering report/2011/January
- WMF Engineering Overview March 2011 → Wikimedia engineering report/2011/February
[edit] Dependent project pages
These pages shouldn't be attached to their parent pages.
Note: fix double redirects.
