Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
What term to use for the documentation?
Message
 
 
To
15/04/2008 15:10:05
General information
Forum:
Visual FoxPro
Category:
Other
Environment versions
Visual FoxPro:
VFP 9 SP1
Miscellaneous
Thread ID:
01310860
Message ID:
01310890
Views:
23
>>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?

Thank you.
"The creative process is nothing but a series of crises." Isaac Bashevis Singer
"My experience is that as soon as people are old enough to know better, they don't know anything at all." Oscar Wilde
"If a nation values anything more than freedom, it will lose its freedom; and the irony of it is that if it is comfort or money that it values more, it will lose that too." W.Somerset Maugham
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform