User:Zakgreant/Report/2010/07/08/Log

From mediawiki.org

Participated various WikiSym open spaces sessions + lots of discussions with fellow participants.

Coordinated open space session on the MediaWiki docs (thanks to Danese for taking notes)

MediaWiki/Wikipedia Ops Docs Jam[edit]

Notes from OpenSpace Session 2:00pm Thursday, 8 July 2010

Attendees[edit]

  • Danese Cooper
  • Mark Hershberger
  • Michael J. Barany
  • Roan Kattouw

Goals[edit]

For Developer-Facing Docs:

  • Make it easier for Volunteer Devs to extend and use MediaWiki
  • Set up the Docs as a tool to move the Volunteer Dev Community towards higher competency (begin as we'd like to continue...in tone and general norms of addressing future devs*)
  • Writing for Audience (Roan suggests looking at TimS's "Security for Developers" memo). Discussion of the levels of programming that go on...Hooks vs. the Caching Layer for instance
  • Documentation on existing extensions - probably a focus for later. The ones used at WMF should be held to a higher standard. CentralAuth a very bad example, relies on SiteConfiguration to work, but this fact isn't mentioned.

For Ops Docs:

  • Memorialize decisions, config changes
  • Supplement / fix existing docs to support crisis action
  • Educate next round of SysOps
  • Shorten time to useful contribution

Suggestions[edit]

  • Standard URLs for each code / feature element
  • Marking code for flaws such as poor security
  • Log bot for mediawiki_security to catch crisis interventions for later documentation
  • Discussion of various bots that already run...
  • Discussion of bug system
  • Shell access?

Comparison of the two types of "Technical Documentation"[edit]

Dev/Code Ops
Reference Crisis
Tutorial Policy
Deployment
Sources Sources
Doxygen (code) wikitech
TXT Docs in SVN wikimedia.org
Mediawiki.org office wiki
IRC IRC
Meta
various 3rd party resources developer's heads
Lacks Lacks
completeness completeness
high-level overview high-level overview
parser
no quality assurance no quality assurance
no coverage assurance no coverage assurance