>>>I am really a stickler for proper terminology and can't find the right word for the following. I am documenting my application. I try to document all classes and methods and properties. But I also want to write a description of how various important "things" work in the application (from the technical standpoint). Like "in order to update this important field, the program uses this class that instantiates another class, calls this or that method, and using certain properties." What I don't have is a good word for a header of this descriptions. The only two that come to mind are Features and Functions.
>>>
>>>Any other suggestions, recommendations?
>>>
>>
>>How about Functional Description? That's what I'm using in a current project.
>>
>>Tamar
>
>If I may ask you a follow up question, please. I am writing my documentation using Word and would like to embed some simple flow diagrams (like showing how one class method calls another and so on). If you are also using Word and you put diagrams and flow charts in your document, what tools do you use?
On the project I mentioned, Whil Hentzen and I are working together and we're doing all this in a wiki, not in Word.
Tamar
Previous
Next
Reply
View the map of this thread
View the map of this thread starting from this message only
View all messages of this thread
View all messages of this thread starting from this message only