How to correctly write an installation or setup document

I just joined a small start-up as a software engineer after graduation. The start-up is 4 year old, and I am working with the CEO and the COO, even if there are some people abroad. Basically they both used to do almost everything. I am currently on some kind of training phase. I have at my disposition architecture, setup and installation internal documentation. Architecture documentation is like a bible and should contain complete information. The rest are used to give directions in different processes.

How to communicate within a company what is being Continually Deployed

I work for a small development company, 20 people total in the entire company, 3 in actual development, and we’ve adopted CD for our commits to trunk, and it works great, from a code management and up-time side. However – we’re getting flak from our support staff and marketing department that they don’t feel that they’re getting enough lead time on new features and notifications on bug fixes that could change behavior. Part of why we love the CD system is for us in development, it’s fast, we fix the bug, add the quick feature, close the Bugz and move on with our day to the next item.

Methods to Manage/Document “one-off” Reports

I’m a programmer that also does database stuff and I get a lot of so-called one-time report requests and recurring report requests.

Lua & Javascript documentation generation

I am in the beginning phase of create a mobile MMO with my team. The server software will be written in JavaScript using NodeJS, and the client software in Lua using Corona. We need a tool to auto-generate documentation for both the server-side and client-side code.

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 change? (Yeah, I know, those methods shouldn’t be public, yada yada yada. I didn’t create my situation, I’m just trying to make the best of it.)

Are XML Comments Necessary Documentation?

I used to be a fan of requiring XML comments for documentation. I’ve since changed my mind for two main reasons:

A better JavaDoc? [closed]

As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for […]

Java code documentation in a separate docs file somehow mapped to a source file?

What would be a good alternative to inline Java documentation, i.e. can one have a separate docs file somehow mapped to a java source file?

Seeking advice on system documentation

I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document but now I need something more technical (a technical specification).

Why is it said that V-model introduces QA?

In several articles and books I learnt that “V-model introduced QA into SW development”.