Questions tagged [documentation-generator]
Software to assist in the generation of documentation.
77
questions
1
vote
0
answers
34
views
Good software for technical documentation?
I would like to create some technical documentation. My requirements are that:
I can run it on a server as a website.
It is editable as some sort of markdown and editable by a fairly non-technical ...
- 111
1
vote
0
answers
10
views
Replacement for Clarify
Clarify (and before that ScreenSteps) was an application I used on macOS to quickly create visual documentation. The site still exists today, but the software (understandably) no longer works (well).
...
- 555
1
vote
1
answer
32
views
static site generation platform for huge amounts of documentation
At our company we have deployed several static file generators like sphinx, docfx or docusaurus. They are used by different departments and the goal is to get all on one platform.
We've tried to ...
- 11
0
votes
0
answers
9
views
What are good end-user documentation platforms for an open source JavaScript library project?
I am the developer of the WebMidi.js JavaScript library. The project already has API documentation that is being generated with JSDoc. I would like to add searchable end-user documentation.
Basically, ...
- 101
0
votes
2
answers
22
views
Do tools for generating documentation of PostgreSQL data warehouses/databases exist?
Something like Sphinx but for SQL, so we could document table structures and relationships in a series of web pages.
- 121
0
votes
1
answer
21
views
chapter title versus tree presentation
I am writing a document.
It has multiple chapters with titles.
e.g.
1. Hardware
1.1. CPU
1.1.1 RISC
blabla
1.1.2 CISC
blabla
1.2. Memory
...
The chapters form a soft of tree.
Is there a ...
- 111
1
vote
0
answers
79
views
Are there any differences between the programs Sandcastle Help File Builder, DoxyPress, Doxygen?
Questions.
Are there any differences between the programs Sandcastle Help File Builder, DoxyPress, Doxygen?
Or are these programs the same in functionality and you can use any of them?
Description.
...
- 11
0
votes
1
answer
122
views
Tool to convert a groff ms document to HTML
I'm looking for a tool for converting groff ms documents to HTML.
In particular, I would like the generated HTML to produce hyperlinks from each entry in the Table of Contents to the section in the ...
- 130
2
votes
2
answers
66
views
Looking for software: create, manage, export manuals
I'm creating manuals for several, related industrial products - some have common chapters that I need to link, not duplicate (to make updating feasable)
What I need (functionality):
a GUI
local ...
- 21
1
vote
0
answers
10
views
Form generation tool for automated generation of multiple PDF documents
I need to manage several form documents (in fillable PDF format), and most of them share a lot of information like headers, footers and some of the fields. Right now, every time a change needs to be ...
- 111
0
votes
0
answers
33
views
Documentation generation tools that parse only comments blocks
I am looking for documentation generation tools that only interpret the comment blocks when generating code documentation. It means that, to some extent, the tool does not depend on the programming ...
- 101
-1
votes
1
answer
47
views
A Simple Document creating software, with export options of PDF..?
I have checked Word, and other PDF creating software like PDF Element, Foxit, Adobe.. etc..
but they were difficult to use, and bloated..
I want something Simple and Easy as QUIP - software, or Google ...
- 21
1
vote
0
answers
9
views
Database description language with converter backends?
I develop on a project that failed in the first run (without me) because the database was getting more and more inconsistent, having been defined ambiguously and never documented officially. A new ...
- 11
0
votes
1
answer
701
views
Tool to generate javadoc in PDF format
We can generate javadoc using javadoc tool.
However i am looking for a wizard or tool to generate javadoc in different formats - HTML, PDF.
I come across Aurigo but it was out-dated. Last update on ...
- 157
1
vote
1
answer
43
views
Open source program for documentation network and assets in company
I'm looking for the open source, web program for networks and assets documentation in my company. Which can help with visualization like Visio but working on the web interface. I mean - my employees ...
- 13
1
vote
1
answer
47
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 ...
- 89
2
votes
0
answers
162
views
Is there a high-quality commercial or open source alternative to Doxygen?
I frequently work with large bodies of C++ or Objective C source code and am growing increasingly frustrated with Doxygen.
It's horribly slow for significant code bases (> 1 million lines of code), ...
- 180
1
vote
1
answer
37
views
I need a suggestion for a small yet dynamic custom document automation/generation project. Currently using Excel
Summary:
I have one particular client that requires us to deliver a few annual packages and letters to their partnership members. Say, roughly 500 members. The letters have paragraph text, line ...
- 11
2
votes
0
answers
14
views
Single tool, ideally open source, for specifying application use cases, requirements, and functional specifications
Is there a free or inexpensive tool that supports the development of Use Cases (or User Stories), Requirements, and Functional Specifications? I know there is a tendency to blur the lines between ...
- 21
1
vote
1
answer
38
views
Helpdesk, community, knowledgebase, documentation
We're building a SaaS app. I'd like use another SaaS to handle the customer service parts of the app. Specifically, I'm looking for:
Single sign-on. When the customer signs into our app, they should ...
- 111
2
votes
0
answers
26
views
Writing tool for documents with multiple authors
I'm looking for a tool for teachers. They write assessments for their pupils. So each teacher writes one per pupil. The software should collect all single assessments and create one large document out ...
- 21
1
vote
0
answers
36
views
I need a good open source and still maintained C/C++ library that can Read/Write (process) .docx and .xlsx files
As the title says, and sine I am a C++ developer (and mainly using wxWidgets as a toolkit) my purpose for it is to provide an editable reporting application. I will give the users a sample templates ...
- 13
1
vote
0
answers
143
views
Flutter Source code documentation generator
Is there a good program to generate documentation from dart source code? similar to javadoc or Doxygen I am aware dartdoc exist but that is only for api documentation as far as I know
- 11
0
votes
1
answer
30
views
Tool to document web API
Context
I have a soap web API which is built in java with spring.
The API is part of a service which is one component from a microservice.
There is no possibility of manually writing the ...
- 101
0
votes
0
answers
9
views
Java tool for automatically generating documentation for SOAP-based APIs?
Is there any Java tool that, given an JavaEE SOAP API, the tool will automatically scan the package containing the endpoints of the service. The tool should also provide access to a route (something ...
- 101
1
vote
3
answers
215
views
Headless CMS for collaborative working on user manual
The Headless CMS I am looking for will be used by approx. 5 developers, creating a user manual. This manual will contain images, rich text, links, tables and lists. The target audience are mostly Non-...
- 133
1
vote
0
answers
145
views
Best way to document REST APIs in (go) source?
I am working on a REST API implemented in go.
I have already wrestled with godoc
Colleagues have started using apidoc.js but I have found in lacking in several areas. For example I don't even know ...
- 111
0
votes
0
answers
14
views
Looking for ways to make devs aware of shared components
We are currently growing in size, and i keep finding devops trying to reinvent stuff that already exist. Is there any tool you guys use that help maling the shared levels a bit more transparent?
- 111
1
vote
0
answers
25
views
Application/documentation for managing flow between servers
I'm working on application Integration and with the help of one Network guy we are managing the flows between our application and the others.
To Sum up me problem, we have several version of that ...
- 11
1
vote
1
answer
53
views
Moving doxygen comments from source to header
Are there any tools available to automate moving Doxygen comments from source files to the corresponding headers? Nothing listed on the Helper tools and scripts page seems to handle that, and I've not ...
- 113
1
vote
1
answer
41
views
C++ or C# module documentation tool for both API reference and online book
There are some documentation tools for C++ or C# module developers.
Doxygen: Best for generating cross-reference API reference documentation, but it is hard to author an online book (overview, ...
- 161
1
vote
1
answer
69
views
App to draw bit/byte based messages from plain text description
I think I saw a similar question here a few years back, just just can't find it.
I would like to draw descriptions of messages like this:
From a plain-text input file which describes them.
Maybe ...
1
vote
1
answer
87
views
Math writing tablet apps instead of LaTeX
I am not fluent in LaTeX and was wondering whether any of the new iPad pen-input apps are very useful for writing math documents more fluently than using LaTeX as a proxy language. If so, which one/...
- 111
2
votes
0
answers
76
views
C++ UML generation/edit tool
What I want is a proper UML tool for C++;
I need the following features:
generation of class diagram from (complex) c++ source
including class members
showing members as relationships where possible
...
- 21
2
votes
2
answers
403
views
Is there any tooling to document PLC code per IEC 61131 (formerly IEC 1131)?
I'm looking for documentation generator tooling - whether open-source, gratis, or not, for programmable logic controller (PLC) code, i.e. the IEC 61131-3 family of programming languages.
By a ...
1
vote
0
answers
45
views
C# Winfroms GUI Documentation
For a library project without a GUI I'm using XML documentation tags in my C# code and Sandcastle to create a help / documentation file for the API. I really like this, because every time I add ...
- 111
-1
votes
1
answer
31
views
Is Google's Developer Documentation tooling public?
Did Google publish their public developer documentation tooling/generators? I'm talking about the documentation available from the https://developers.google.com/ family of URLs. E.g. https://...
2
votes
1
answer
100
views
Tool for software documentation purpose
I'm a software developer, and I'm looking for a tool in order to write software documentation in collaboration with my team.
This means that, this tool should be has some mechanism of versioning in ...
- 121
0
votes
0
answers
36
views
Software tool to assist me in documenting a file format
There's this file format which I want to write some documentation for. It's intended for humans, but should be specific enough so that a person could essentially parse the format (if perhaps slowly) ...
- 2,942
1
vote
2
answers
88
views
Swagger User Interface without JSON/YAML
My boss asked me for a tool to do swagger documentation through UI without typing in JSON/YAML based data.
He wanted something like a form with fields where if we type in relevant details like ...
- 121
1
vote
2
answers
29
views
Generate Certificate (award)
I need to generate A4 letter/certificate/award online that can be printed by users that works on all devices. It has to look nice and allow me to dynamically add text to it.
Currently I have a .NET ...
- 111
1
vote
1
answer
44
views
Report generating tool for Microsoft Word (team-based)
The Problem
I work with a team of people where we frequently generate reports specific to clients, regions, and topics. Each time we begin a new report, we open up several older reports which cover ...
- 320
1
vote
0
answers
27
views
Software for Android App Documentation
I am doing documentation of my Android app. I want to create a documentation of my product like Facebook does in their docs. I am looking for a software which can help me to document my product for my ...
0
votes
0
answers
27
views
Assemble user documentation from pieces
We have a web-based enterprise application which has many different areas of functionality. Most of our users only have access to a limited subset of that functionality. That can range anywhere from ...
- 411
0
votes
1
answer
57
views
Software wiki framework that jupyter's doc uses?
I'm looking at the jupyter platform docs
https://jupyter-notebook.readthedocs.io/en/latest/
looks like this
I've seen this platform many times
What is it called?
It looks similar to jekyll ...
- 381
0
votes
0
answers
463
views
Open Source Document Automation - Jinterview Alternative
Is anybody aware of an open source document automation software like similar to jinterview: http://jinterview.sourceforge.net/default.htm
Jinterview was abandoned so long ago that I have been having ...
- 223
2
votes
1
answer
79
views
Tool to generate angular documentation searchable via tags
I work in a company and we have a lot of projects that are using angularjs. My issue here is that we are around 30 devs and it is quite hard to be aware of all directives/components/services that ...
- 121
12
votes
3
answers
15k
views
A robust and flexible alternative to doxygen supporting C++
I need to generate documentation for a C++ project of mine (and soon perhaps also for additional ones). So far I've looked into doxygen, and even though it seems popular, I've had some issues with it (...
- 2,942
2
votes
1
answer
108
views
Tool for documenting server configuration
My team is looking for a COTS tool that would allow us to document our different environments with the following info:
What applications & websites live on a server
What IPs map to a server
What ...
- 21
4
votes
3
answers
209
views
Which platforms to use for writing documentation/help/manual?
I came to a point where it is absolutely necessary to have some kind of documentation about my product. So some sort of help or user manual for customers, because i want to reduce the number of emails....
- 143