Stack Exchange Network

Stack Exchange network consists of 174 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

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.

2
votes
1answer
459 views

Is this synchronization required in service onCreate method?

Below is a sample code i captured from android doc Per service instance onCreate will be called only once. Ref: here and here The synchronization and singleton doesn't make any sense to me in this ...
0
votes
1answer
195 views

Interactive help in a statically-typed language with overloading

One of the nice features of IPython is that I can inspect a function. In [1]: def inc(x): ...: """Increments a number""" ...: return x+1 ...: In [2]: inc? Type: function ...
3
votes
0answers
878 views

Representing a user event in a flow chart

I was wondering which symbol should be used for representing a user event (i.e. button click). seems like it should suffice, but isn't a user click technically ?
3
votes
0answers
304 views

Documenting and handing over Source Code

I have recently left my previous student job as a part time developer for at small ERP management firm. During my time at the firm i have developed several modules for integration with the ERP ...
2
votes
0answers
151 views

Standard for order of tags in PHP DocBlocks?

Based on the tags listed from this "standard", is there an order of the tags that people typically follow? Even if it's not something that has been entirely accepted, but something proposed? I am ...
1
vote
0answers
55 views

Adding documentation after modifying the code

In our TFS (Version 14.102.25423.0) I can click Browse on home page, then under Browse Server, pick my project and hit Navigate. Once inside my project, I see tabs like Home Code Work Build ...
1
vote
0answers
205 views

Shared pointers across threads in UML for class and sequence diagrams

How does one represent shared pointers across threads in UML for class diagrams and sequence diagrams? I especially want to document the ownership of the memory even though it's accessibility (a ...
1
vote
0answers
84 views

Should I use RFC 2119 in interface documentation?

RFC 2119 defines several terms, including MUST, SHOULD, and MAY, for use in standards documents, particularly those relating to networking protocols such as IP and HTTP. These terms are widely used ...
1
vote
0answers
31 views

Scala/SBT - Documenting Configuration Change for Releases

I'm trying to collect different ways of managing configuration across multiple environments. I have a requirement to document configuration changes for the deployment plan. Dev values are defaults in ...
0
votes
0answers
35 views

Are REST Resources and GraphQL Object Types conceptually equal?

I'm in the process of outlining the intended business logic of a web service. At this point, I'm not too concerned with implementation details. On the contrary, I'm looking for ways to abstract them ...
0
votes
0answers
73 views

When documenting code, should you seperate different languages into different documentations / files?

I am currently working on a project with hundreds of methods, I started it blind without any documentation and im only now starting to put in documentation. I have 2 major languages within the code, ...
0
votes
0answers
47 views

How-to incrementally improve JavaDocs

I started working at a new company in the past year. I'm used to having pretty complete JavaDocs with edge cases noted (such as what happens when null is passed to the method). I'm pushing for making ...
0
votes
0answers
124 views

How to document kwargs in Sphinx style?

I'm wondering how I can document **kwargs in Python using sphinx dostring style. For example I have the following method and I want to document more details about kwargs. def get(self, url=None, **...
0
votes
0answers
465 views

Documentation Structure in Software Development Life Cycle documentation

In creating documentation for a project's life cycle, is it better to have all decisions and choices (including their resources such as images) placed in the same document, or is it better to ...
0
votes
0answers
56 views

Formal documentation - frequent Support-Cases

I have the task to document support cases for some Interfaces, which happen on a frequent base. This documentation is for the stakeholders: Developers for a new Interface Domain Exports Technical ...