Tag Info

New answers tagged

1

If you have the financial resources, the manpower (a team for a synchronized multitasked work environment), the time for self (or paid) training and the will to participate in a much slower than SE community for help, Adobe's "Technical Communication Suite" is your solution. It's the top notch, state-of-the-art, standards supporting "technical documentation" ...


2

In test-driven development the emphasis is on writing tests that clarify what code should do, rather than extensive documentation. Future maintainers of the code can then ensure that the code continues to exhibit the behavior it should by virtue of the tests. The way tests are named form a type of documentation of the proper behavior of the code. Here is an ...


8

Introduction The Biggest reason documentation is written is to help developers learn about the software system and give them a reference to the tools they are using. This is a broad question and I must admit most of the tips I will give will be my opinions and things I've found helpful. Below are some guidelines and design aspects you can use to help ...


1

This guy is from Drexel, so he must be right: use the leading zero. http://mathforum.org/library/drmath/view/52352.html I found one quote on that site especially interesting, since it implies that the leading zero was customarily left out in the English system of units, but was strongly urged in the metric system of units. "In the United States, the ...


10

Unless you have a very good reason not to, you should include the leading zero. The combination of leading zero and decimal point is far more recognizable than the decimal point by itself.


6

The Chicago Manual of Style says that the inclusion or omission of a leading 0 depends on whether quantity could be greater than 1. If the quantity could be greater than than 1, include the leading 0. Especially if quantities greater than 1 appear in the same context. For quantities that are always less than 1, it is typical to omit the leading 0. CMoS ...


3

If this is user-facing documentation, then make up a data dictionary that describes the tables and columns with supplementary blurbs about the meaning of the data (e.g. the meanings of specific values in a column). This can be a straightforward HTML document with the supplementary descriptions as text. If you need to produce E/R diagrams then Visio ...


1

It depends on your audience. Blessed Geek suggested UML enumeration, but this assumes that the users understand UML. Your question shows that you know technology well enough to know the capabilities of your users. Writers often use Javadoc or Doxygen to generate API documentation because those tools easily generate new docs when the API itself changes. ...



Top 50 recent answers are included