Questions tagged [documentation-generator]

Software to assist in the generation of documentation.

Filter by
Sorted by
Tagged with
4
votes
1answer
79 views

Update images in documentation automatically

I'm looking for a tool/software to keep software documentation for a website project always up-to-date. Especially the images in the documentation, e.g. explaining user masks etc. gets out of sync ...
0
votes
0answers
9 views

For Java, are there any more modern/recommended forms of documentation, than just Javadocs? [closed]

I am currently in the early stages of developing a piece of Java software with another dev, and we are both wondering if there is a more up-to-date/recommended documentation framework and viewer than ...
12
votes
6answers
9k views

.NET documentation generator alternatives to Sandcastle?

I was looking for a tool to build my documentation. Sandcastle is good but it seems not work for .NET core projects and is old and buggy. Is there any good alternative that can generate docs for .NET ...
0
votes
0answers
11 views

Tool to create documentation from a SQL query

At my company we have a project where we write select SQL queries on different financial software databases to insert into a pre-designed database table we created. An example query would be: ...
0
votes
0answers
8 views

Software to combine documentation comments from multiple IDEs

I have a product for three different platforms, Windows, Android and iOS, and I'm looking for a program or a group of programs to combine and format their documentation comments. The languages that ...
0
votes
0answers
20 views

Visual Studio 2017 typescript documentation tool

I updated my Visual Studio to the 2017 version and started a new TypeScript project. Let's say I have a class with 100 lines of code. Now I want to auto create the documantation for my class. I know ...
4
votes
1answer
329 views

Generating PDFs from XML comments

Background I write a lot of code in C#, and use XML comments all over the place to describe how my methods, members, and properties behave. I would ultimately like to compile all of the information ...
1
vote
1answer
24 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 ...
1
vote
1answer
35 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, ...
0
votes
0answers
17 views

How would you move from Pandoc to Confluence?

We are evaluating moving from a Pandoc markdown generated website to Confluence for internal technical documentation - do you have any experience with such a migration?
1
vote
0answers
10 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 ...
0
votes
0answers
15 views

LaTeX themes for doxygen

Doxygen is a tool to generate documentation from source code. It supports many output formats, of which PDF is one of it. The output can be further customized with LaTeX documents and style sheets. ...
0
votes
0answers
7 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 ...
0
votes
0answers
5 views

Converting HTML Form values into a formatted document

I want to create an application where the user input(from a form) determines the content of a generated document. This document needs to be formated, and the content has to be displayed in the correct ...
2
votes
0answers
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 ...
0
votes
0answers
16 views

NodeJS - Create a document from a template

I'm trying to figure out a way to create a document from some data in NodeJS. I'm building a web app to serve as a report form. I want to pass data from it to a database and later create printable ...
27
votes
4answers
26k views

What tool can generate HTML documentation from C# code, like Javadoc can do for Java?

Java developers can easily generate HTML documentation from their Java code, which is a convenient way to post APIs online. This is an example. Is there a similar tool for C# code? It must be free,...
0
votes
0answers
7 views

Crawling a JS-heavy web page with Chrome Headless, saving to html, convert to PDF

Is there a GUI- or commandline-based tool that can crawl a Javascript-heavy web site and save the ~50 pages encountered to .html files? Then I'd like to convert the HTML pages to PDF. Finally I'd like ...
1
vote
0answers
8 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 ...
1
vote
2answers
161 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 ...
0
votes
0answers
11 views

Documentation platform

Here in the company, we need to make online documentation available for several users. Currently, our little documentation is created in MS Word and made available to users in PDF format, but we need ...
0
votes
0answers
5 views

Is there a tool to author and manage release notes for various software modules in IBM Rational toolsuite?

My organization is using the IBM Rational tool suite(DOORS, Rational Team Concert etc). However, Release Notes for various modules are being maintained using MS Word documents. Is there software ...
1
vote
0answers
36 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
0
votes
0answers
7 views

Tool to draw graphics by template definition

We are generating technical documentation at work and are currently taking screenshots then manually draw on the screenshot to highlight different areas or controls in the image. The text in the ...
3
votes
0answers
136 views

Natural language generation for Japanese

I am looking for tools, libraries, software or services to generate natural Japanese text from raw data. The best example of what I am trying to do is the commercial tool Wordsmith from Automated ...
0
votes
0answers
8 views

JS documentation engine for API reference, tutorials and product blog

I'm looking for documentation engine for API reference, tutorials and product blog with the following requirements: Implemented in JS and has JS API Generates static content Support themes Does not ...
1
vote
2answers
104 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-...
0
votes
0answers
16 views

Is there a tool or plugin which can automatically annotate scala code?

I'm currently writing documentation for my Scala code so I can generate Scaladocs. I'm curious however, is there any tool or plugin (I'm using IntelliJ IDEA CE) I can use to auto annotate the code to ...
0
votes
1answer
23 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 ...
0
votes
0answers
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 ...
0
votes
0answers
6 views

Database documentation from JPA annotations

I am tasked with implementing better DB schema documentation at work. It was requested to investigate whether this can be done based on Annotations in an @Entity class. We are using Spring Boot and, ...
6
votes
1answer
227 views

Comprehensive Technical Documentation Tool

Background Looking to unify technical documentation, bridging computer- and user-generated content, using open source tools. The goal is to write (or generate) content in an output agnostic file ...
0
votes
0answers
36 views

PHP Library for convertation from PHP doc to OpenApi annotations

I need a lib that can parse phpdoc of Yii2 controller's actions and generate proper OpenApi annotations (to use https://github.com/zircote/swagger-php/ for swagger config generation). Did anybody do ...
1
vote
1answer
27 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 ...
7
votes
2answers
7k 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 (...
7
votes
2answers
777 views

Selfcontained software to generate static HTML documentation from Markdown

I'm searching for a tool that can generate static HTML pages from markdown files. So far so good, there are plenty out there: mkdocs daux beautiful docs flatdocs My problem is that I would like to ...
0
votes
1answer
55 views

Generator for Java software documentation other than Javadoc

I built a lot of webMethods. Each webMethod has his own logic implementation. I want to generate documentation, but not using Javadoc. I'm looking for software that creates a text file (or other ...
1
vote
2answers
318 views

Code documentation system (like javadoc/pydoc etc), which is pluggable for less common languages (eg SAS)

At work, along with the more "typical" languages like Java and Python (for which we have pretty good documentation tools already), we have quite a lot of SAS code as well. The work there to produce ...
2
votes
2answers
848 views

Which tool would you use for producing REST API docs from Java code?

There are a lot of these tools to choose from, of varying levels of quality and various models from open source to commercial. I need to document REST apis, either Spring MVC or javax.ws.rs. My ...
1
vote
0answers
71 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 ...
0
votes
0answers
13 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?
1
vote
1answer
44 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
0answers
19 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 ...
0
votes
0answers
26 views

Tool to generate API-like documentation for complex html element collections

I searched, couldn't quite find anything similar, but apologies if asked and answered before. Looking for a tool (in whatever form, standalone program, script, cli executable, something to go in the ...
2
votes
1answer
71 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 ...
1
vote
1answer
79 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/...
2
votes
0answers
57 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 ...
1
vote
0answers
33 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 ...
-1
votes
1answer
24 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://...
0
votes
0answers
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) ...