Confirmed users
556
edits
MDN/Projects/Completed/GitHub Integration: Difference between revisions
Jump to navigation
Jump to search
MDN/Projects/Completed/GitHub Integration (view source)
Revision as of 16:16, 5 December 2013
, 5 December 2013no edit summary
Groovecoder (talk | contribs) No edit summary |
Groovecoder (talk | contribs) No edit summary |
||
| Line 13: | Line 13: | ||
* edit-review workflow: GitHub has very nice tool support for creating, reviewing, and revising content. Changes can be reviewed and corrected before going live, so you avoid those "This article is in need of a technical review." banners. | * edit-review workflow: GitHub has very nice tool support for creating, reviewing, and revising content. Changes can be reviewed and corrected before going live, so you avoid those "This article is in need of a technical review." banners. | ||
* editorial control: it's possible to control who gets to edit a page, and to make sure edits go through a particular channel. This means spam isn't a problem, and that it's possible to make sure doc updates are made consistently. | * editorial control: it's possible to control who gets to edit a page, and to make sure edits go through a particular channel. This means spam isn't a problem, and that it's possible to make sure doc updates are made consistently. | ||
* writers don't need to use MDN's editor. The MDN editor is fine, but when I use it I find quite often that the WYSIWYG editor doesn't quite give me the control I want, and end up having to hand-write HTML, which is not a nice thing to have to do. | |||
* the documentation is versioned alongside the code. This makes it simpler for versions of the documentation to track versions of the code. It's easier to say: this specific revision of the docs is applicable to this specific version of the product. | |||
* it's relatively easy to generate documentation from the source. This might be full-on in-source documentation, or just something like reading metadata structures out of the docs (for example, the Add-on SDK docs read API stability and mobile support from the code that implements the APIs). | |||
== How will we measure the value? == | |||
What is the expected value and impact and how will we measure it? | |||
* | * Increase MDN reach? | ||
** More docs on MDN? | |||
** New audience coming to MDN? | |||
* Improve documentation quality? | |||
** Readers bounce around less? | |||
* What else? | |||
==How could we do it?== | ==How could we do it?== | ||