Corporate Wiki Organization - Technical Documentation

Posted by Dave Jarvis on Stack Overflow See other posts from Stack Overflow or by Dave Jarvis
Published on 2010-03-31T21:34:19Z Indexed on 2010/03/31 22:03 UTC
Read the original article Hit count: 347

Filed under:

documentation

|

wiki

|

corporate

|

project-organization

Corporations have documents describing various aspects of their technical systems, including:

Custom Applications
Custom Development Frameworks
Third Party Applications
- Accounting
- Bug Tracking
- Network Management
How To Guides
User Manuals
Software Tools
- Web Browsers
- Development
  - IDEs
- Graphics
  - GIMP
  - xv
- Text Editing
- File Transfer
  - ncFTP
  - WinSCP
Hardware
- Servers
  - Web
  - Database
  - Exchange
  - File
- Network Devices
- Printers

What other items are missing from the list, and how would you organize it? (For example, would Software Tools make more sense under Third Party Applications?) Try to think about where you, a software developer, would expect to find the information by browsing (not searching).

A few constraints:

The structure should not go beyond three levels deep.
Avoid the word "and" in favour of two different categories.
Keep the structure general: it should appy as broadly as possible.
Target audience is primarily technical.

© Stack Overflow or respective owner

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More

Related posts about wiki

Minimal way to render Wiki Syntax (for example MoinMoin Wiki)

as seen on Stack Overflow - Search for 'Stack Overflow'
I enjoy using to Wikis to document all kind of stuff (recently I used MoinMoin, so I am used to that syntax). No I am looking for a more light weight solution, for documents were setting up a moinmoin server is to much hassle. What is the "easiest" way to render a .txt file in Wiki syntax. (for… >>> More
Easiest way to render Wiki Syntax (for example MoinMoin Wiki)

as seen on Stack Overflow - Search for 'Stack Overflow'
I enjoy using to Wikis to document all kind of stuff (recently I used MoinMoin, so I am used to that syntax). No I am looking for a more light weight solution, for documents were setting up a moinmoin server is to much hassle. What is the "easiest" way to render a .txt file in Wiki syntax. (for… >>> More
/planes and /clubs or /wiki/planes and /wiki/clubs

as seen on Programmers - Search for 'Programmers'
I am currently working on a nice application about which I can't share all the details, but it will have some sort of a wiki part. In this wiki, you will be able to change the planes as well as the clubs, maybe in the future it will be possible to change the countries and manufacturers as well. But… >>> More
Setting the Default Wiki Page in a SharePoint Wiki Library

as seen on Simple Talk - Search for 'Simple Talk'
I’ve seen a number of blog posts about setting the default homepage in a wiki library, and most of them offer ways of accomplishing this task through PowerShell or through SharePoint designer. Although I have become an ever increasing fan of PowerShell, I still prefer to stay away from it unless… >>> More
A Guided Tour of Complexity

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
I just re-read Complexity – A Guided Tour by Melanie Mitchell , protégé of Douglas Hofstadter ( author of “Gödel, Escher, Bach”) http://www.amazon.com/Complexity-Guided-Tour-Melanie-Mitchell/dp/0199798109/ref=sr_1_1?ie=UTF8&qid=1339744329&sr=8-1 here are some notes and links: Evolved… >>> More