Questions tagged [documentation]
The documentation tag has no usage guidance.
18
questions
0
votes
1
answer
22
views
Dynamic picture for documentation
Could you suggest a tool to present a "dynamic picture" of software architecture with a level of detail? So that you can zoom in and out and see different levels of detail. In general this ...
0
votes
0
answers
18
views
Is there sphinx like support for godoc to directly reference code docs from user docs?
Coming from python/sphinx I'm use to having a "docs" folder (in sphinx it would be written in rst format) with usage/tuts/reference/etc info and in those docs I can directly reference my ...
- 131
1
vote
0
answers
6
views
How to extract documentation from SpringShell @ShellMethod annotations
I am developing a shell from SpringShell and use the @ShellMethod to annotate the methods that are invoquable from the Shell. The annotation includes a brief description of the command/method.
@...
- 11
0
votes
0
answers
13
views
VS Code extension for more customizable comment visualization
Does anybody know a good VS Code extension for visualizing comments? Right now I am using the default VS Code stuff together with Doxygen Documentation Generator extension. It looks a bit like this :
...
user84422
0
votes
0
answers
9
views
Are there any existing documentation systems that can be built directly on Langchain?
I currently have a documentation system that is auto-generated by Sphinx. Recently, I came across Langchain (https://python.langchain.com/docs/get_started/introduction.html)
A next-generation ...
- 1
1
vote
1
answer
44
views
Open source self hostable documentation tool needed
I am looking for a web based tool to host some documentation.
Something like confluence but without payments.
I already found documize but it has issues if you want to build it by yourself and also is ...
- 13
0
votes
1
answer
21
views
Python Documentation Tools
I'm researching open-source tools and packages to generate Python documentation for modules and functions containing docstrings.
I understand sphinx is good for parsing manually created docstrings ...
- 31
0
votes
0
answers
34
views
Is backstage.io a good software for maintaining, documenting and monitoring an IoT network?
I'm an Engineer working for a city. We're currently implementing a sensor network across our town and we're looking for a software, that allows us to maintain, document and monitor sensors, but also ...
Michael
2
votes
0
answers
29
views
Good wiki software for both internal docs and customer-facing technical documentation?
Context
I work for a heavy equipment company, and we currently have all our documentation as PDFs on a big network drive. This works alright for the gigantic mass of technical documentation (hydraulic/...
- 121
2
votes
0
answers
302
views
Is there a documentation generator for TypeScript Vite/ESBuild projects?
When I switched from JavaScript to TypeScript, I switched the documentation generator from JSDoc to TSDoc as well. However since using Vite and Vitest, which depend on ESBuild and not TypeScript, ...
- 211
2
votes
0
answers
46
views
Documentation tool for DB-applications
I have to implement a DB application, but the implementation should be also documented.
My goal is to create a document not only for the developers, but also for other departments (who do not need to ...
- 21
0
votes
1
answer
31
views
Free tool/framework/program to create high quality rest API documentation?
Could you please recommend free tool/framework/program to create high quality rest API documentation?
Thank you
1
vote
0
answers
15
views
Open source web based too to document request flow
We are building an application which interfaces with multiple systems to complete a flow. For example, I have a REST service to get the list of users, then it has to talk to 4 separate systems to ...
- 111
1
vote
1
answer
121
views
Simple PDF centralized signing/approval system for LAN environment
In our office we typically have this highly in-efficient workflow:
User A writes a technical report with recommendations
There are between 4-5 people that must sign this document for it to be released
...
- 11
1
vote
0
answers
8
views
Good documentation reader for finding references quickly
While I do programming, I need to search for references. I want a free (and maybe open-source) software to do that for me. It should also be compatible with Linux. As most softwares and libraries use ...
1
vote
0
answers
20
views
Is there software that allows for convenient offline viewing of Python3 documentation on GNU / Linux?
Programming in C is really convenient for me on a GNU / Linux OS because documentation for all the standard library functions are at my fingertips via locally installed man pages.
Some of my current ...
- 193
1
vote
1
answer
49
views
From README.md at github to something better?
Several months ago I start to write down my guidelines at github:
https://github.com/guettli/programming-guidelines
The lists get longer and now I would like to improve the structure.
I guess it is ...
- 157
1
vote
2
answers
40
views
Offline documentation for Javascript/ES6, Vue, PHP, ... + a good frontend
A couple of weeks ago I was working in a remote place, with very shaky internet connectivity. I had to solve some technical problems. Some them were Javascript problems. However, it was impossible ...
- 2,754