Software documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles.
8
votes
3answers
111 views
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 ...
2
votes
1answer
68 views
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 ...
0
votes
4answers
167 views
Is extensive documentation a code smell? [closed]
Every library, open-source project, and SDK/API I've ever come across has come packaged with a (usually large) documentation file, and this seems contradictory to the wide-spread belief that good code ...
2
votes
2answers
119 views
What norms/standards should I follow when writing a functional spec?
I would like to know what documents (ISO?) should I follow when I write a functional specification. Or what should designers follow when creating the system design? I was told that there was a ...
3
votes
5answers
187 views
What are the benefits and drawback of documentation vs tutorials vs video tutorials [closed]
Which types of learning resources do you find the most helpful, for which kinds of learning and/or perhaps at specific times?
Some examples of types of learning you could consider:
When starting to ...
3
votes
4answers
72 views
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.
I work at a company that has a SQL Server database that we ...
3
votes
2answers
130 views
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 ...
1
vote
2answers
92 views
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 ...
2
votes
4answers
141 views
What Does It Usually Mean for a Feature to be “Supported”?
I'm currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I ...
2
votes
1answer
183 views
What to put in a Stored Procedure documentation?
I was tasked to document our stored procedures.
Target audience: Technical
Purpose: To have a good documentation in preparation for
migration.
I'm assuming someone has already done it.
4
votes
2answers
103 views
How to document requirements for an API systematically?
I am currently working on a project, where I have to analyze the requirements of two given IT systems, that use cloud computing, for a Cloud API. In other words, I have to analyze what requirements ...
-2
votes
2answers
147 views
Specifying Author in Source Code in a Commercial Product
Usually there is an @author tag in API documentation (JavaDoc, PHPDoc etc). Is it acceptable to use this tag on every function you make in a commercial product?
3
votes
3answers
116 views
What level of detail to use in an interface members descriptions?
I am extracting interfaces from some classes in .NET, and I am not completely sure about what level of detail of description to use for some of the interface members (properties, methods).
An ...
5
votes
1answer
92 views
How to visually document interactive user interfaces for fast consumption
I'm writing documentation for some interactive Ajax user interface but instead of writing everything in words I would rather provide diagrams that are faster consumed than whole paragraphs of text. I ...
0
votes
2answers
146 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 ...