Questions tagged [documentation-generator]

Software to assist in the generation of documentation.

Filter by
Sorted by
Tagged with
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,...
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 ...
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 ...
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 ...
4
votes
3answers
175 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....
4
votes
1answer
3k views

C++ code documentation generation tool

I want to automatically generate HTML documents for C++ code and have used Doxygen in the past, but if I, for example, look at the NVIDIA CUDA documentation, there must be better tools ;-) Does ...
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 ...
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 ...
3
votes
2answers
140 views

How to document (describe in HTML) Oracle schema?

I'm trying to find a tool (or simple program, script, jar file) to describe my oracle database (schema). What I need from output report: HTML format ER diagram in output Table and Columns ...
3
votes
0answers
27 views

Generate documentation from background image, text and screenshots

I'm trying to create a set of User Manuals for a fairly large product that changes frequently. To save myself the hassle of editing the documentation all the time to update screenshots, I'm looking ...
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 ...
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 ...
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 ...
2
votes
1answer
75 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 ...
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 ...
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 ...
2
votes
0answers
29 views

How can I create a beautiful online tutorial on a software library?

I would like to create a tutorial with code examples like: http://learnyouahaskell.com/chapters Are there some HTML/CSS templates or other tools for this?
2
votes
0answers
355 views

Java library to create PDF documents with Acroforms (Free + gratis)

I am looking for a library which, like Apache FOP, enables you to start from a template document (which has the contents in XML, similar to HTML), and apply styling to it, to create a PDF. I have been ...
2
votes
0answers
72 views

What tools can I use to create simple editable documentation pages with NodeJS and AngularJS app?

I'm developing a website that will, in addition to other pages and functionality, have a documentations section with navigation and search capabilities. I want to make it easily editable with CRUD ...
2
votes
0answers
120 views

Online PHP documentation tool

I'm searching for a documentation generation software like phpDocumentor or phpDox for scripts written in PHP. As both mentioned softwares are running with root permissions (apparently), I can't use ...
2
votes
1answer
93 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 ...
1
vote
2answers
22 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 ...
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 ...
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-...
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 ...
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, ...
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
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/...
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 ...
1
vote
2answers
68 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 ...
1
vote
1answer
37 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 ...
1
vote
1answer
13 views

Looking for tools to write components documentation with source and runtime example like angular

I really like angular's documentation where you have the source and beside it the runtime result. for example https://angularjs.org/#wire-up-a-backend I am looking for tools to help me get similar ...
1
vote
1answer
60 views

Restful Web Services api documentation tool

Before during, and even after Web Services implementation, an up-to-date user guide is very important to our customers. I am trying to find an API tool for Restful Web Services which can produce a ...
1
vote
1answer
607 views

Free tools for open source project documentation?

I am looking for free tools for open source project documentation. I am trying to start an open source project on GitHub. The project is a Ruby on Rails web app (RESTful backend) with Postgres or ...
1
vote
1answer
21 views

What software can I use to edit interlinked HTML files without reading source code?

My company has inherited a large user guide that is comprised of a master .htm that works as a table of contents and has hyperlinks to child .htm files that are either a leaf(containing the desired ...
1
vote
1answer
40 views

Generating multiple PDF documents from spreadsheet and images

I am looking for a free or low cost product that i can use to quickly create multiple PDF documents populated with text and images from a spreadsheet. I have a background image which will the a ...
1
vote
1answer
60 views

AngularJS Code Documentation Tool

Is there any Free open source Code Documentation Tool for AngularJS projects. I've used YUIDoc JavaScript Code Documentation Tool but it does not seem to be very suitable for AngularJS, because the ...
1
vote
1answer
30 views

Content generator to generate a description for entries

I'm working on an automated solution to help speed up my daily tasks. I'm in the design phase currently, so things are still being worked out in how this is exactly going to work, however, I am trying ...
1
vote
1answer
61 views

Documentation generator tool for multiple languages

I have project that written with Ruby, Java, Python and Bash and currently I'm searching for single documentation tool that can be used to generate web pages, like Sphinx-doc does Precondition is not ...
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
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 ...
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
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
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 ...
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 ...
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
vote
0answers
22 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 ...
1
vote
0answers
20 views

Share information documenting the architecture

One of the most important things in a company with a complex architecture is share information across different teams. The documentation helps the new people have joined the company, the handover, the ...
1
vote
1answer
108 views

Granular document management and creation tool

I'm looking for a document or content management tool - I'm not quite sure of the generic name for the tool I'm looking for**. Our use case is creating collection of documents each of which offer ...