Technical document

lankapala used Ask the Experts™
Hi Expert,
Technical Documentation is writing before development/Project start or after completed the project?
Watch Question

Do more with

Expert Office
EXPERT OFFICE® is a registered trademark of EXPERTS EXCHANGE®
Enterprise Business Process Architect
The process of Technical Documentation is generally begun at project inception and continues through project completion, becoming more refined and coherent as the project approaches completion.  The project should not officially be closed until Technical Documentation is complete.
Ryan ChongSoftware Team Lead

Technical Documentation is writing before development/Project start or after completed the project
Technical documentation can be written during the process of development and review during the development life cycle.

In common, the release of the technical documents would be around the project deployment period, but this need to be confirmed, negotiated, planned and agreed with your client. You also need to do scoping on what areas to be covered in your various techical documents, and try to capture the details as clear as possible.
bbaoIT Consultant

can we know what's your ultimate point to ask this question? i guess that would let us address your concern specifically rather talking about technical document in general.

FYI - in actual projects, changes always happen hence technical documentation needs to be updated in a practical way as per business needs and rules.
There is quite old approach called "literate programming" (Donald Knuth, The idea is to write documentation in the form the narrative text with snippets of the real code. Then the tool is used to extract and reorganize the code snippets from that narrative source files into the code source files that are later compiled.

In my opinion, it may fit to some brains. It definitely worked for Donald Knuth. Anyway, I am not sure if it works for project under time pressure with many people in the team.

The alternative approach is to write "narrative comments" to the source code, and then to use a tool to extract and reorganize the comments. In my opinion, this approach is more successful in real environment.

The key idea is to keep the code and the documentation as closely bound together as possible. It must be extremely easy to locate the part of the documentation and the related part of the implementation code.

As there may be more people that will share the same files, you need some decent Version Control System. (Learn Git, if you can choose. You cannot go wrong.)



Do more with

Expert Office
Submit tech questions to Ask the Experts™ at any time to receive solutions, advice, and new ideas from leading industry professionals.

Start 7-Day Free Trial