

10 + 15 points
Document documentation by David G
September 12th, 2008 2:46 AM
I'll do you one better! I'll document examples of some of my company's documentation of the code that generates the documentation we provide to users on our website. (I'll do you two better, actually; read to the bottom.)
In this pic, the red text is the documentation documentation (that I hereby document by way of the photo and this explanation). I wrote the file last month when we changed how the documentation part of our site was structured. Its job is to handle URLs people type in, provide navigation links, show overview pages with summaries of sub-pages, and display the actual content.

Here's more red text that documents the workings of our "docs" pages.

Finally, this one perhaps goes a step further. Users can write code on our website, and of course we have to document how to do that. But they can also document their code, and we pull the documentation out and format it for them. So we need docs about how that works!
This photo documents the code that generates a message that tells a user they are viewing generated documentation, and points them to our documentation-generation documentation, which is included among the documentation pages shown in the above photos.

To be clear about my claim of potential "doc doc doc docs", here are the levels:
In this pic, the red text is the documentation documentation (that I hereby document by way of the photo and this explanation). I wrote the file last month when we changed how the documentation part of our site was structured. Its job is to handle URLs people type in, provide navigation links, show overview pages with summaries of sub-pages, and display the actual content.

Here's more red text that documents the workings of our "docs" pages.

Finally, this one perhaps goes a step further. Users can write code on our website, and of course we have to document how to do that. But they can also document their code, and we pull the documentation out and format it for them. So we need docs about how that works!
This photo documents the code that generates a message that tells a user they are viewing generated documentation, and points them to our documentation-generation documentation, which is included among the documentation pages shown in the above photos.

To be clear about my claim of potential "doc doc doc docs", here are the levels:
- A user on our website writes their own library and wants to document it.
- They read our documentation page on how to do so in compliance with our tools.
- The page they read is generated by the code documented with red text in the first photo (where it says "gendocs" near the bottom).
- In completing this task I am documenting that red text.