Comments on: Documentation For? http://ifacethoughts.net/2006/11/19/documentation-for/ Thoughts on software development and related, by Abhijit Nadgouda Wed, 17 Mar 2010 22:27:34 -0600 http://wordpress.org/?v=2.9.1 hourly 1 By: Optimizing Code For Reading | iface thoughts http://ifacethoughts.net/2006/11/19/documentation-for/comment-page-1/#comment-422594 Optimizing Code For Reading | iface thoughts Tue, 16 Jun 2009 03:38:22 +0000 http://ifacethoughts.net/2006/11/19/documentation-for/#comment-422594 [...] In-line comments can be effectively used for things that cannot be conveyed by code at times - the rationale behind design decisions and the problem the code is trying to [...] [...] In-line comments can be effectively used for things that cannot be conveyed by code at times – the rationale behind design decisions and the problem the code is trying to [...]

]]> By: My Mom Is Not Going To Read This Code | iface thoughts http://ifacethoughts.net/2006/11/19/documentation-for/comment-page-1/#comment-200448 My Mom Is Not Going To Read This Code | iface thoughts Mon, 10 Mar 2008 11:55:36 +0000 http://ifacethoughts.net/2006/11/19/documentation-for/#comment-200448 [...] is not evil. I document to record rationale behind certain decisions or to document the problem that the code solves. There might be cases where you are building an API [...] [...] is not evil. I document to record rationale behind certain decisions or to document the problem that the code solves. There might be cases where you are building an API [...]

]]> By: Abhijit Nadgouda http://ifacethoughts.net/2006/11/19/documentation-for/comment-page-1/#comment-1968 Abhijit Nadgouda Sat, 25 Nov 2006 02:20:08 +0000 http://ifacethoughts.net/2006/11/19/documentation-for/#comment-1968 Completely agree with you Doug that user documentation and developer documentation target different people and should be significantly different in their composition and even the language. Developer documentation is useful in all cases as they record the decisions along with the reasons behind them. Completely agree with you Doug that user documentation and developer documentation target different people and should be significantly different in their composition and even the language. Developer documentation is useful in all cases as they record the decisions along with the reasons behind them.

]]> By: Doug Karr http://ifacethoughts.net/2006/11/19/documentation-for/comment-page-1/#comment-1965 Doug Karr Fri, 24 Nov 2006 18:29:35 +0000 http://ifacethoughts.net/2006/11/19/documentation-for/#comment-1965 User documentation and developer documentation should differ significantly. Development documentation should be written in the event the developer is 'hit by a truck' and someone must immediately assume the responsibility for troubleshooting and enhancing the application. User documentation, however, should provide the user with how the application can be utilized to solve the problem it was developed for. Too many times, application documentation is written as a roadmap to navigate the software rather than how to solve the actual problem. User documentation and developer documentation should differ significantly. Development documentation should be written in the event the developer is ‘hit by a truck’ and someone must immediately assume the responsibility for troubleshooting and enhancing the application.

User documentation, however, should provide the user with how the application can be utilized to solve the problem it was developed for. Too many times, application documentation is written as a roadmap to navigate the software rather than how to solve the actual problem.

]]>