# Automatic doc generation

**URL:** https://discourse.nodered.org/t/automatic-doc-generation/67378
**Category:** General
**Created:** [6 September 2022 07:27 UTC](https://discourse.nodered.org/t/automatic-doc-generation/67378 "2022-09-06T07:27:02Z")
**Posts on this page:** 4
**Page:** 1

<div class="post-metadata">

### Author: ![173](https://avatars.discourse-cdn.com/v4/letter/1/d26b3c/32.png) [@173](https://discourse.nodered.org/u/173)
#### Post date: [6 September 2022 07:27 UTC](https://discourse.nodered.org/t/automatic-doc-generation/67378/1 "2022-09-06T07:27:02Z")

</div>

hi to everybody,

is there a way to automatically generate documentation of a flow from its structure and the descriptions inside the modules and/or comments?

(sorry if the question is so basic, I am quite new with node-red)

Thanks in advance

---

<div class="post-metadata">

### Author: ![bakman2](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/bakman2/32/6207_2.png) [@bakman2](https://discourse.nodered.org/u/bakman2)
#### Post date: [6 September 2022 08:35 UTC](https://discourse.nodered.org/t/automatic-doc-generation/67378/2 "2022-09-06T08:35:32Z")

</div>

As far as I know, this is not possible.

However, you can give nodes a "name" - if you make this verbose/descriptive, you can create self-describing flows.

 ![SCR-20220906-ep3](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/a/d/adc343319ecc534549488c268db5ac75c81c1ec2.png)

---

<div class="post-metadata">

### Author: ![TotallyInformation](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/totallyinformation/32/31_2.png) [@TotallyInformation](https://discourse.nodered.org/u/TotallyInformation)
#### Post date: [6 September 2022 08:50 UTC](https://discourse.nodered.org/t/automatic-doc-generation/67378/3 "2022-09-06T08:50:05Z")

</div>

Along with that, you can use comment nodes and use groups to put a set of nodes that describe a process into a group with a bounding box and a title. So between all of those things it is possible to create flows that can be printed to a PDF and will still be understandable.

---

<div class="post-metadata">

### Author: ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)
#### Post date: [5 November 2022 08:50 UTC](https://discourse.nodered.org/t/automatic-doc-generation/67378/4 "2022-11-05T08:50:19Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.
