Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 19:52, 10 April 2014
, 10 April 2014→In a separate file in the gfx/docs directory
Msreckovic (talk | contribs) |
Msreckovic (talk | contribs) |
||
| Line 23: | Line 23: | ||
* The documentation is versioned | * The documentation is versioned | ||
* The documentation is subject to reviews | * The documentation is subject to reviews | ||
* The source file should contain a pointer to the documentation, and vice versa. Use the | * The source file should contain a pointer to the documentation, and vice versa. Use the markdown syntax. | ||
* There is no preference between this and the 'in source code' approach. Use what's more appropriate, except do not have documentation for the same design in both source and separate file. | * There is no preference between this and the 'in source code' approach. Use what's more appropriate, except do not have documentation for the same design in both source and separate file. | ||
=== In wiki, blog, random web page, etc. === | === In wiki, blog, random web page, etc. === | ||