Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
What term to use for the documentation?
Message
 
General information
Forum:
Visual FoxPro
Category:
Other
Environment versions
Visual FoxPro:
VFP 9 SP1
Miscellaneous
Thread ID:
01310860
Message ID:
01310923
Views:
38
>>>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 it is good enough for you, it should work for me too. And I like the way it sounds too. Thank you very much.

I am going to disagree with Tamar, which I don't do very often. To me Functional Description implies a description of a system from the user's POV -- what it is supposed to do. Screens, reports, menus, updates, etc. When you document a system's classes, methods, and properties you are describing the system's technical internals. It would be of no interest to end users or managers, only to developers.

I don't know a better term for your document. Technical Documentation maybe?

On your follow-up question about embedding flow charts and the like in a Word document, have you looked at Visio? It comes with some versions of Office as well as being for sale on its own. The last I knew there was a free 60 day trial version.
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform