Depending on the project, there are a number of artifacts that might be produced. On top of the number of documents, they also come in many formats (and some are produced in multiple formats). So how do you keep everything organized and up-to-date, especially in a project with a large amount of documentation? ...
Visual Studio does it; Reflector does it; and now I want to as well :) I want to retrieve the xml documentation for some members in some framework assemblies (i.e. mscorlib.dll, System.dll, etc). I assume this would involve: finding the xml file for the assembly, navigating to the appropriately named child element, and retrieving th...
I am making a strong effort to discipline my projects and create a Vision/Scope document at the onset. Included in this are the use case diagrams. Just listing out the use cases has really helped me fully see all the requirements that the customer is asking for, and it has opened up dialog. I am wondering about how detailed the use ca...
I not sure if it is me but seen like developer don't really like to document because they find it easier to explain things briefly instead of documenting it down and from time to time have to update the document. And another thing is that consultant come up with use cases for different functionality should they then also write the unde...
Do you know any good (starting) tutorial or documentation about OSC? ...
I am currently documenting our development process, and more importantly the reasons why we do it a particular way. I am planning to write in the style that I used during my (physics) degree, and which is common in many mathematics and physics textbooks, which is along the following lines: "Therefore, we now see that X is Y, because of...
I ask because I quite enjoy it! I'm talking about design documentation and implementation notes (NOT user manuals), which are non-existent in most of the codebases I've been handed. I can understand why a developer wouldn't want to write requirements (that's the analyst's job) or the user documentation (that's a technical writer's job) b...
Accidentally I may forget to describe some parameters or exception throwing (or something else) when documenting methods or classes, etc. Is it possible to run javadoc in such a way that it warns me about missing documentation items? (I use ant script for generating documentation) ...
Wikipedia provides a number of citations used in the sciences, however does one stand out in computer science and software engineering related documents? My initial guess is to the IEEE format, as they have a number of conferences and publications related to both fields, but I couldn't find anything definite. ...
Hi, At the moment I am using Visual Source Safe (yeah yeah!) to store my Technical Specification documentation. The actual docs are written in MS word. If find that having the spec written in word format to be a big burden, for specs to be truly used there shouldn't be any barrier to usage and more importantly access. If I can't quic...
If I start writing a user-manual for applications I have written, I have a hard time to look at the application from a users standpoint. I know it's not very useful to write something like: To use the foo-function click on the foo-button, choose the foo-type from the list and type a foo-name. After that you can click on submit and your ...
Apart from Joel's article on the subject, where can I find information to help me get a deeper understanding of Unicode? ...
I have a Microsoft Project Gantt chart and I need to convert it to a pert Chart . Can any one please help me ...
I'm in the process of exploring our next development platform. So far, I have chose asp.net MVC with MS SQL Server for persistence. I want to document the best practice and standard that my team will use. In the process, I want to read about each aspect, make some prototypes and summarize my conclusion. Even after my initial conclu...
What is syntax for adding comments in an access query? ...
Can anyone suggest easy ways to document how web pages in a relatively complicated web application link to each other? Should I document them in Visio possibly? That seems the easiest. I need to check each of the different buttons and functions on each page, and some of these depend on how the user accesses each page, so I need to doc...
I'm working on a tagging system at work, but one thing that I would be interested in is determining what has already been learned about the way people use such systems so that, when using libraries and tools and creating code, I can accommodate the way people do things (or so I hope). After asking this question, I continued to go throug...
Should we do this or argue that certain audit requirements shouldn't force us to write excessive documentations? What are your views? ...
I'm developing an application which has a lot of text and also different modules which can be included or not in every build. For each saved project we generate automatically a report with all the details (i.e. description of algorithms used in that project and so on). Currently we embed all text as strings in the source code and we als...
Google guys seems to know their game and I like learning from those smarter than me. Google is sharing a lot of code with open source community. Their docs and APIs are IMO state of the art. Which tools / APIs would you recommend for a C++ developer? I'm interested both in looking at interesting solutions / tricks as well as using some G...