2
votes
2answers
650 views

How do I document a communication protocol on top of message queues and channels?

I'm working on a large project at the moment and I'm trying to document the communication protocol that sits on top of a message queue middleware. The documentation is intended for another ...
1
vote
2answers
313 views

What kinds of visual content, tables or diagrams might I want to include in my Project Architecture Document?

Besides logical and physical architecture diagrams, comps / mockups and tables for expected network load between components and various data schemas, what kinds of visual content, tables or diagrams ...
3
votes
8answers
8k views

Is there a symbol or shorthand for “and is increasing/decreasing”?

This usually happens when I'm writing to developers or other IT professionals. The context would be something along the lines of ". . . measured at 100 MB/s (and is increasing)." On paper or a ...
1
vote
2answers
154 views

Would you keep convincing your management some better practices if he keeps screwing things up

My manager, an enthusiastic programmer, is full of good energy to program. But he has a ... habit were he will be negligent in meetings if he can't understand the issue or argument. As a result, he ...
6
votes
4answers
134 views

Do you have any teamguidelines regarding exceptions?

My team recently inherited a project from a team where the amount of developers dropped so low they had to offload some work. One of the projects we inherited was a project littered with nested code, ...
37
votes
18answers
2k views

How can I improve my technical writing?

Writing documentation is part of programming, and writing well is part of what makes the documentation useful. So, what are some hints or guidelines for good writing in the technical realm? What are ...