# Can I automatically create documentation for my templates?

**URL:** <https://forum.inductiveautomation.com/t/can-i-automatically-create-documentation-for-my-templates/18704>\
**Category:** Ignition\
**Created:** [July 3, 2018, 9:02am UTC](https://forum.inductiveautomation.com/t/can-i-automatically-create-documentation-for-my-templates/18704 "2018-07-03T09:02:54Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![abiesbiogas](https://avatars.discourse-cdn.com/v4/letter/a/919ad9/32.png) [@abiesbiogas](https://forum.inductiveautomation.com/u/abiesbiogas)\
**Post date:** [July 3, 2018, 9:02am UTC](https://forum.inductiveautomation.com/t/can-i-automatically-create-documentation-for-my-templates/18704/1 "2018-07-03T09:02:54Z")

</div>

Good morning to everyone!  
I recently began working with Ignition and I have to document the templates I make for my collegues, so they won’t be frustrated by the “unknown properties” of a million objects sombody else made.  
Other enviroments (other technologies), offer tools as Javadoc and swagger that permit me to generate the documentation while writing the code it refers to.  
As I got negative feedback from the customer care (ther aren’t any tools for auto-generate documentation) I think I have to write my own tool and I ask if someone encountered my same issue and maybe want to share any idea/result.  
Personally I woud write a script to scan all the templates and write in a file (xml?) the structure of my objects, the way that I can build a database and consequently search within the generated data the cross references and so on.

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [July 3, 2018, 12:33pm UTC](https://forum.inductiveautomation.com/t/can-i-automatically-create-documentation-for-my-templates/18704/2 "2018-07-03T12:33:15Z")

</div>

> [@abiesbiogas](#):
>
> Personally I woud write a script to scan all the templates and write in a file (xml?) the structure of my objects, the way that I can build a database and consequently search within the generated data the cross references and so on.

Sounds very useful. Please do! (-:  
And report back here with the tool....

---

<div class="post-metadata">

**Author:** ![abiesbiogas](https://avatars.discourse-cdn.com/v4/letter/a/919ad9/32.png) [@abiesbiogas](https://forum.inductiveautomation.com/u/abiesbiogas)\
**Post date:** [July 4, 2018, 9:29am UTC](https://forum.inductiveautomation.com/t/can-i-automatically-create-documentation-for-my-templates/18704/3 "2018-07-04T09:29:02Z")

</div>

> [@abiesbiogas](#):
>
> I think I have to write my own tool and I ask if someone encountered my same issue and maybe want to share any idea/result.

Thank you pturmel for your interest! 🙂

Actually I'm still curious to know if anybody else had the same idea and maybe wants to discuss/share his/her results 😄
