Experience/Articles about "decision tree" documentation?

Posted by Philipp Keller on Stack Overflow See other posts from Stack Overflow or by Philipp Keller
Published on 2010-04-10T12:59:00Z Indexed on 2010/04/10 13:03 UTC
Read the original article Hit count: 394

Filed under:

documentation

|

bug-fixing

|

Operations

I'm running an "defect fixing" group (developers do 2 weeks operations, then rotate).

I want to build up a documentation "how to deal with problem x" - basically a decision tree:

Is the problem in part x of the web site?

Yes: Is the problem occurring in all browsers?
 Yes: ...  
 No: ...  
No: ...

The documentation should be written and extended by the people using it. Do you know of any book/article describing how that is best done, or is there a software (Mac OS X) that helps doing that?

© 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 bug-fixing

bug fixing appproach

as seen on Programmers - Search for 'Programmers'
I have been working on a project comprising of databases. I recently received a bug report for the remote execution of some queries. Usually you try to find out the actual cause for the bug to occur and then fix it. But sometimes what I do when I'm fed up of doing some research (and can't find… >>> More
What is your ratio Bug fixing vs Enhancements ?

as seen on Stack Overflow - Search for 'Stack Overflow'
In the spirit of this question I wanted to have a sense of what is the proportion of time split between fixing bugs and implementing new features. If possible try to give an estimate for the product as a whole as opposed to individual developer stats and try to make an average over the course of… >>> More
Enjoy bug fixing more than coding from scratch

as seen on Stack Overflow - Search for 'Stack Overflow'
As I get more and more into my job I've had a lot of opportunity to code new projects from scratch. Almost every programmer I know really appreciates that opportunity. But the further I go into it, the more I enjoy bug fixing. In fact, if I can spend a whole day looking over code, whether it be… >>> More
Agile bug fixing - what's the preferred process for testing?

as seen on Programmers - Search for 'Programmers'
When a bug is fixed, the dev set its status to "resolved" and the bug is reassigned back to the person that created it. In our case this is usually the product owner - we don't have dedicated testers. But what's a good process for controlling how/when the PO tests the software? Should he be given… >>> More
Experience/Articles about "decision tree" documentation?

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm running an "defect fixing" group (developers do 2 weeks operations, then rotate). I want to build up a documentation "how to deal with problem x" - basically a decision tree: Is the problem in part x of the web site? Yes: Is the problem occurring in all browsers? Yes: ...… >>> More