Comments on: Documentation, documentation, documentation http://www.sitepoint.com/blogs/2005/02/23/documentation-documentation-documentation/ News, opinion, and fresh thinking for web developers and designers. The official podcast of sitepoint.com. Tue, 02 Dec 2008 06:53:55 +0000 http://wordpress.org/?v=2.5 By: Nick http://www.sitepoint.com/blogs/2005/02/23/documentation-documentation-documentation/#comment-12071 Nick Fri, 16 Dec 2005 22:52:42 +0000 931899862#comment-12071 Maybe their developer documentation is great, but the documentation for end-users - i.e. those not wanting to improve MapBuilder is lacking. I'm not saying there isn't any, but if you are not a JavaScript developer, and just include it in your web pages occasionally for the added flair, getting started as a MapBuilder user can be quite painful. I don't think I'm alone in feeling this way, based on some comments I've seen throughout the MapBuilder-lib website. Still, great project! Maybe their developer documentation is great, but the documentation for end-users - i.e. those not wanting to improve MapBuilder is lacking. I’m not saying there isn’t any, but if you are not a JavaScript developer, and just include it in your web pages occasionally for the added flair, getting started as a MapBuilder user can be quite painful. I don’t think I’m alone in feeling this way, based on some comments I’ve seen throughout the MapBuilder-lib website.

Still, great project!

]]> By: bwarrene http://www.sitepoint.com/blogs/2005/02/23/documentation-documentation-documentation/#comment-3735 bwarrene Wed, 31 Dec 1969 19:00:00 +0000 931899862#comment-3735 <p>This is probably one of the weakest areas in development projects is substantial documentation. Often it is lacking due to pure exhaustion from limited resources - other times it is a lack of a good technical writer willing to contribute. This kind of documentation should serve as a benchmark for what should be delivered with any application undertaking.</p> This is probably one of the weakest areas in development projects is substantial documentation. Often it is lacking due to pure exhaustion from limited resources - other times it is a lack of a good technical writer willing to contribute. This kind of documentation should serve as a benchmark for what should be delivered with any application undertaking.

]]> By: sil http://www.sitepoint.com/blogs/2005/02/23/documentation-documentation-documentation/#comment-3736 sil Wed, 31 Dec 1969 19:00:00 +0000 931899862#comment-3736 <p>That, I confess, is what drove the post; that JSDoc and cohorts do lower the bar to documentation, because it's not necessarily a whole separate process. While "just add comments and pow! you get documentation!" understates the case somewhat, it's easier to add the comments, even if they are a little laborious, than it is to produce documentation when you start with a blank page.</p> That, I confess, is what drove the post; that JSDoc and cohorts do lower the bar to documentation, because it’s not necessarily a whole separate process. While “just add comments and pow! you get documentation!” understates the case somewhat, it’s easier to add the comments, even if they are a little laborious, than it is to produce documentation when you start with a blank page.

]]> By: SUPERUSER http://www.sitepoint.com/blogs/2005/02/23/documentation-documentation-documentation/#comment-3737 SUPERUSER Wed, 31 Dec 1969 19:00:00 +0000 931899862#comment-3737 <p>As I said working with JSDoc on the command line was a pain in the ass, until I found that little utility JSDocumenter. Which is in fact a GUI for JSDoc. It solved my JavaScript documentation problems in just a second. If you haven't tried it yet, then you're losing with every second. </p> As I said working with JSDoc on the command line was a pain in the ass, until I found that little utility JSDocumenter. Which is in fact a GUI for JSDoc. It solved my JavaScript documentation problems in just a second. If you haven’t tried it yet, then you’re losing with every second.

]]>