2
votes
2answers
497 views

What do you call parentheses operators?

In most programming languages documentation where they talk about operators +-*/=<> they also include ()[] as operators. There are unary operators, multiplicative operators, additive operators, ...
0
votes
1answer
471 views

Are there differences between Functionality and Functional Requirements [closed]

I'm writing some documentation in a project in a tool. In this tool of mine, and write in specific area, I have here use Case, Business Rule, N-Diagram Types, and Functionality and Functional ...
8
votes
3answers
168 views

How to document experimental or incomplete APIs like @deprecated?

Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
2
votes
4answers
205 views

What Does It Usually Mean for a Feature to be “Supported”?

I'm currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I ...
7
votes
4answers
1k views

Is functional spec a “design document”?

So I have been a bit lost in the terms, so first of all I present you what I have learned so far: System requirements specification - what users want, what the system should do Functional requirement ...
12
votes
4answers
289 views

What exactly comprises 'Documentation'?

When we say 'documentation' for a software product, what does that include and what shouldn't that include? For example, a recent question asked if comments are considered documentation? But there ...
8
votes
6answers
1k views

What is a good non-technical example of a cumulative error?

I'm working on a report which needs to explain in non-technical terms the effects of a cumulative error, and why it is of importance to use absolute calculations. Definition of 'cumulative error' ...
1
vote
2answers
880 views

Is there a difference between property and attribute?

These two words are completely synonymous for me, but I wonder if there's actually a useful semantic difference that I can incorporate into coding/naming conventions/process.
2
votes
1answer
701 views

what is the meaning of a “Teardown Report”

I am sorry if this a wrong place to ask the question. I saw the usage "Teardown report" for a product What does it mean?
30
votes
3answers
993 views

Origin of “Readme”

When did people start writing Readme files? It seems that pretty much all programs have this file, regardless of the format. Is there any documented first use of this document?
1
vote
4answers
271 views

Use the terms “vector” or “array” in high level discussion of C++ code

When I write high-level documentation about what an algorithm does, I use the term "array" to refer to the data structure on which the algorithm operates even though the actual data structure is an ...
6
votes
10answers
416 views

What do I call people who extend my class in base class documentation?

Been calling them "implementers", but it seems weird to me. /// <summary> /// Implementers should implement this. Derp /// </summary> protected abstract void InternalExecute(); A point ...