What are the best practices for technical reports

Posted by Abel on Stack Overflow See other posts from Stack Overflow or by Abel
Published on 2009-06-24T21:45:50Z Indexed on 2010/04/04 9:03 UTC
Read the original article Hit count: 272

Filed under:

documentation

How do you, as a programmer, think that a technical report on a software should be done, in a manner that can optimize the task of another programmer take it and start feeling confortable with the code as fast as can.

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Best Practices for Data Warehousing with SQL Server 2008 R2

as seen on SQL Authority - Search for 'SQL Authority'
An integral part of any BI system is the data warehouse—a central repository of data that is regularly refreshed from the source systems. The new data is transferred at regular intervals by extract, transform, and load (ETL) processes. This whitepaper talks about what are best practices for Data… >>> More

Developer IT

What are the best practices for technical reports - Developer IT

What are the best practices for technical reports

documentation

Related posts about documentation

Hyperlinked, externalized source code documentation

A tool to aid completion of missing or incomplete source code documentation

Quick C# Project Documentation in Visual Studio

SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

SQLAuthority News – Best Practices for Data Warehousing with SQL Server 2008 R2

Categories cloud