What format is your documentation in?

Posted by Ek0nomik on Stack Overflow See other posts from Stack Overflow or by Ek0nomik
Published on 2010-03-25T19:07:13Z Indexed on 2010/03/25 19:13 UTC
Read the original article Hit count: 167

Filed under:

documentation

|

word

|

html

|

sharepoint

I am going to be writing documentation for two web services that I developed, and I started wondering what people on here do for documentation.

Do you create it in an HTML file so it can be viewed in the browser? Word document? Wiki? What do you guys/gals use?

I was originally leaning towards creating an HTML page since it seems a little more open and friendly than a word document. Plus I can use the prettify javascript to make code samples look nice. Our company has a Sharepoint though, so an HTML file may not be the best choice given that most documentation is put up in spreadsheets and word documents.

© Stack Overflow or respective owner

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 – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More

Related posts about word

Microsoft Word - Word count excluding specific Styles?

as seen on Super User - Search for 'Super User'
Hi, I was wondering if there's a way to get a word count that excludes text with a specific Style in a Microsoft Word 2007 document? I've seen this related question, but I've got blocks of source code scattered throughout which would mean I'd have to go through each of my documents a section at… >>> More
Using Word COM objects in .NET, WinWord process won't quit after calling Word.Documents.Add

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm running into the classic scenario where, when creating Word COM objects in .NET (via the Microsoft.Office.Interop.Word assembly), the WinWord process won't exit even though I'm properly closing and releasing the objects. I've narrowed it down to the use of the Word.Documents.Add() method. I… >>> More
Unable to open word file (MSWord 2007) when word automation program is running

as seen on Stack Overflow - Search for 'Stack Overflow'
In my application i am using word automation to get the text content from the file. It is working fine no issues. But at the instant when word automation is processing, if i open the word file, it is throwing a dialog with message (any file) "This file is in use by another application or user. (C:\User\xyz\AppData… >>> More
Unable to build my c++ code with g++ 4.6.3

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
I am facing multiple issues with building my c++ code on Ubuntu 12.04. This code was building and running fine on RH Enterprise. I am using g++ 4.6.3. Here's the output of g++ -v. g++ -v Using built-in specs. COLLECT_GCC=g++ COLLECT_LTO_WRAPPER=/usr/lib/gcc/i686-linux-gnu/4.6/lto-wrapper Target:… >>> More
Dreamweaver Delete Space to Word, Not Word

as seen on Super User - Search for 'Super User'
There's a built in DW keyboard shortcut (Ctrl + Del) that deletes up to AND INCLUDING the first word to the right. I used to use the ColdFusion Studio app for coding and it would just remove the space UP TO the word (left the word or bracket, or whatever alone.) Any DW users know if this is a setting… >>> More