Questions tagged [documentation-generator]
The documentation-generator tag has no usage guidance.
0
votes
0answers
3 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, ...
0
votes
0answers
5 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
0answers
39 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
0answers
18 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
1answer
23 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 ...
0
votes
0answers
25 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 ...
0
votes
0answers
44 views
Free SQL Server Documentation Tools ?
I'm working on a large SQL Server database with no documentation,Are there any(opensource) documentation tools which supports SQL server 2016.I'm specifically looking in into the following.
Document ...
0
votes
1answer
30 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
23 views
Software used to write and/or generate RFC-style documents
I've always been curious how RFC documents are written. For example, the Atom spec in text form.
What software is used to write these documents?
What software is used to generate these documents (if ...
0
votes
0answers
25 views
Free tool for use cases documentation
In our company we use Docmenta as a tool for installation manuals, user cases and specifications list, but it's becoming too slow and we want to update it. Any recommendation? Thanks!
We need to ...
1
vote
1answer
41 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
73 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
51 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
2answers
94 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
0answers
29 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
22 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
1answer
61 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 ...
0
votes
0answers
35 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) ...
1
vote
2answers
53 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
2answers
21 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
1answer
34 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
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 ...
0
votes
0answers
20 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 ...
0
votes
1answer
32 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 ...
0
votes
0answers
361 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 ...
2
votes
1answer
73 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 ...
7
votes
2answers
5k 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
votes
1answer
90 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 ...
4
votes
3answers
167 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....
8
votes
5answers
6k 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 ...
1
vote
0answers
16 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
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
56 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 ...
3
votes
0answers
26 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 ...
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
285 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
123 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 ...
6
votes
1answer
190 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 ...
1
vote
1answer
542 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 ...
2
votes
0answers
27 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
2answers
805 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
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
59 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 ...
0
votes
1answer
27 views
Creating Framework documentation tool [closed]
I want to create Documentation for my MVC framework or more specifically a User Manual. Are there any tools for creating such manuals like almost every package of PHP has some sort of user guides.
...
1
vote
0answers
120 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
0answers
308 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 ...
1
vote
1answer
95 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 ...
1
vote
2answers
307 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 ...
