Questions tagged [help-documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
0 votes
2 answers
100 views

How to automatically manage documentation

Our project consists of a cluster of microservices (let's say 20, mainly JS & PHP) that are communicating among themselves and exchanging data (via MQ) among themselves. Also, clusters have API ...
user avatar
130 votes
3 answers
21k views

What's the phone number equivalent of example.org?

RFC 2606 standard reserves the domain names example.org, example.net and example.com for the purpose of being used as examples in documentation. What is an equivalent for a phone number (including ...
user avatar
  • 1,029
21 votes
6 answers
7k views

How do I document my code for minimum time review? [closed]

I want to document my code such that there is minimum need for reading and browsing the code again months later. I know that there are different types of documentation (in source code and outside, ...
user avatar
3 votes
1 answer
151 views

How to document a Software whose requirements are poorly managed? [closed]

Let's say I have a complex software product about which the information or knowledge is scattered all over the organization that built it. There are requirements and features about which even the ...
user avatar
  • 1,503
1 vote
1 answer
580 views

Best approach to learn OpenCV to use with Swift? [closed]

I am trying to figure out how to use OpenCV with XCode's Swift. I need to do realtime video processing for the project I am working on, but I can't seem to find any good references on learning OpenCV ...
user avatar
2 votes
2 answers
238 views

How can I translate my android app help and keep it up to date?

My Android application is almost done and I spend much time creating a set of very precise help pages in HTML that I display using WebViews. I am now ready for the next step, which is i18n. ...
user avatar
3 votes
2 answers
1k views

Is there any taxonomy/language to describe user interfaces?

I'm currently researching the options which I have, to build an 'Online Help System'. This system should offer the user information about dialogs - which consists mainly out of forms. So my main ...
user avatar
  • 41
4 votes
2 answers
4k views

How do I add a Help system to my WinForms project?

I have pretty much completed work on a Winforms application, and would like to add a Help feature for users. I cannot send users to a website, and am thinking along the lines of the kind of help you ...
user avatar
14 votes
5 answers
4k views

Alternativates to HTML Help

We currently use a system called AsciiDoc which allows us to create documentation in a simple text markup. From that we can generate multiple output formats. We only make use of the pdf output and chm ...
user avatar
  • 151