22
Views
2
Comments
How do you document the OutSystems factory for the sake of a knowledge base?

We have the ArchitectureDashboard that gives an overview of the ambient, but how do you document all the applications, modules, extensions, and their goals?

- Why application X exists and what it does?

- Why module Y exists, and what are its goals? Is it reusable?

2021-09-15 19-52-45
Tiago Correia

Hello Gustavo.
Normally we have two types of documentation, the technical documentation and the functional documentation.

For this purpose, I think the most relevant would be the technical one. 

In order to make it easier to inspect the Applications, the modules and so on, I would use the OutDoc component. This component will generate automatically the documentation for your Applications, so you will get a base to work on, or at least will give you a better overview of each module.

Forge link of OutDoc : https://www.outsystems.com/forge/component-overview/159/outdoc

Hope I helped you, good luck!

2022-02-23 12-03-19
Gustavo Nogueira

Hi, Tiago.

I didn't know about this tool. It seems to be similar to .NET Framework documentation tools, that work on an XML.

Will try it out. Thank you! :) 

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.