# Project documentation
**URL:** https://discourse.nodered.org/t/project-documentation/45998
**Category:** Dashboard
**Created:** [20 May 2021 19:38 UTC](https://discourse.nodered.org/t/project-documentation/45998 "2021-05-20T19:38:31Z")
**Posts on this page:** 7
**Page:** 1
### Author:  [@achrefnajjar](https://discourse.nodered.org/u/achrefnajjar)
#### Post date: [20 May 2021 19:38 UTC](https://discourse.nodered.org/t/project-documentation/45998/1 "2021-05-20T19:38:31Z")
hello, i'm a final year student and i have to do a project report wich include the documentation about the node-red part of the project and i have no clue how to do it.
Can anyone share with me a report that can help me do mine .
thanks.
Regards.
Achref.
---
### Author:  [@knolleary](https://discourse.nodered.org/u/knolleary)
#### Post date: [20 May 2021 19:40 UTC](https://discourse.nodered.org/t/project-documentation/45998/2 "2021-05-20T19:40:05Z")
Hi @achrefnajjar
what do you mean exactly? You have used Node-RED in an assignment and you've been asked to document what you've done? If so, then we can't help you with that. We're not here to do your homework for you.
---
### Author:  [@achrefnajjar](https://discourse.nodered.org/u/achrefnajjar)
#### Post date: [20 May 2021 19:50 UTC](https://discourse.nodered.org/t/project-documentation/45998/3 "2021-05-20T19:50:08Z")
i'm sorry but i'm not asking for you to get my job done i'm just asking for a little exemple that i can use to my project.
Thank you .
---
### Author:  [@knolleary](https://discourse.nodered.org/u/knolleary)
#### Post date: [20 May 2021 19:51 UTC](https://discourse.nodered.org/t/project-documentation/45998/4 "2021-05-20T19:51:36Z")
Okay - but an example of what exactly? It isn't clear what you need to document as we know nothing about what you've done with node-red or what the requirements of your assignment are.
---
### Author:  [@achrefnajjar](https://discourse.nodered.org/u/achrefnajjar)
#### Post date: [20 May 2021 20:08 UTC](https://discourse.nodered.org/t/project-documentation/45998/5 "2021-05-20T20:08:57Z")
thank you for understanding, for your information it's my first time of making a report so that's why i'm seeing it like a little hard for me .
about the example, anything, like this nodes for example :
how to document these nodes in a report ?
Thanks.
---
### Author:  [@zenofmud](https://discourse.nodered.org/u/zenofmud)
#### Post date: [20 May 2021 21:04 UTC](https://discourse.nodered.org/t/project-documentation/45998/6 "2021-05-20T21:04:17Z")
Click on each node and then - in the right sidebar - click on the `Help` icon and you will see a description of the node.
that with your knowledge of the flow should give you enough to document the flow.
In addition, there is a `comment` node that you could add on the tab and document the flow there.
Another thing to do is edit each node and use the 'Name' of the tab to say what it is doing.
---
### Author:  [@system](https://discourse.nodered.org/u/system)
#### Post date: [19 June 2021 21:04 UTC](https://discourse.nodered.org/t/project-documentation/45998/7 "2021-06-19T21:04:44Z")
This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.