Hi All,
Thanks for such a good thread and for your contributions.
I'm taking over a medium-size app totally undocumented and struggling to figure out the logic of several processes flowing among various screens. Particularly, there's wide use of hidden components, just for storing values or code, and there are several layers of components, normally hidden, brought to the front depending on the status (as various "containers" implemented in the same screen).
With this scenario in mind, that's how I'm documenting:
- I write inline comments for everything worth and not self-explanatory. If I do relevant changes to a portion of code, I comment the previous one and timestamp it
- I try to keep doc all inside the app and I use external resources (Sharepoint, Powerpoint etc) only if strictly necessary
- If a process runs across more than one screen, I write the description at the beginning of the "starting" property (OnSelect, OnStart, Visible etc.)
It's far from ideal, but at least I'm trying to keep it easy to maintain
I also agree with the aforementioned standardization.
Thanks
------------------------------
Massimo Colaceci
Power Platform Developer
------------------------------
Original Message:
Sent: Jul 10, 2020 04:08 AM
From: Paul Cairns
Subject: Documenting your solutions
Hi,
I need to document the solutions that we've built, primarily using Power Apps, Power Automate and SharePoint. I'd say most are of medium complexity. As a minimum we have commented the code in the app, exported versions of the app, commented when saving etc.
However if I had to hand over the whole solution it would be good to produce documentation, what level of documentation is appropriate to cover the technical spec. For example do you list every control and any logic? Or an overview of the solution, relying on the developer diving into the app/flow/data to pick it apart? Or describe how you achieved each piece of key functionality?
It would be good to hear how others have achieved this.
Many thanks
Paul
------------------------------
Paul Cairns
Systems Developer
Bristol
7891222451
------------------------------