more quick actions
minimize quick actions
Topic starter
Hello,
I am using the "Documentation"-feature of the Application Architect for the first time.
Are there any best practices or templates available for styling the AA-documentation in a good way?
Just to be clear: I am looking for something like the syntax for javadoc or similar...
Posted : 10/10/2016 6:09 pm
Hi Armin,
We have no rules for the Documentation feature. It's a whitepaper.
No specification on Javadoc. What do you want to do with the Javadoc syntax in a documentation tab?
Posted : 12/10/2016 1:54 pm
It could be very good to have such possibility to apply a template and to have one default template at least.
It could encourage people to use it because today it doesn't look nice.
Posted : 13/10/2016 9:15 pm
So far the format is RTF which is quite an old format. Advantage: It is readable by all common tools. Disadvantage: Poor in term of features and outdated.
Javadoc is I think a bit to "developers" oriented. If one day we are going to change this documentation editor/format I would vote for Markdown format.
What is too bad is that we didn't react on this during the development...
Nico
Posted : 14/10/2016 7:49 am