microsoft-365-community icon indicating copy to clipboard operation
microsoft-365-community copied to clipboard

Provide guidance how to document PowerPlatform solutions addressing makers

Open LuiseFreese opened this issue 5 years ago • 3 comments

Article suggestion

I would love to see and contribute to an article that guides Citizen Developers/makers working on low-code solutions in Power Platform how to document correctly. As Citizen Developers mostly don't have formal, institutionalized, or a standardized curriculum following education, they don't know how to document, not for themselves, nor for others.

The guidance that exists is doesn't point to Power Platform solutions and the needs of makers. Just saying "document your code" is not enough. Makers have, most of the time, no or only poor knowledge about naming conventions, comments, programming practices, data models, or that a good documentation includes an ABOUT section in an app, a way to report bugs or request new features, etc. They are also not aware of writing about APIs, endpoints, connectors, licensing, how to install the app, which requirements a user needs to meet, etc.

We need guidance as well on the toolset how to document and how to use GitHub to meet your needs.

Submission Guidelines

I want to work with an experienced contributor as this is my first time, but I will be able to provide a fresh maker-view, and I am willing to learn, and of course: Sharing is caring.

LuiseFreese avatar Sep 01 '20 11:09 LuiseFreese

@sympmarc, If it's ok, @hugoabernier and I would love to be assigned to this with @LuiseFreese and collaborate with her to meet her request. 🤗💜🧡

PopWarner avatar Sep 01 '20 11:09 PopWarner

Awesome idea, and I'm looking forward to what you come up with!

sympmarc avatar Sep 01 '20 13:09 sympmarc

Hello @PopWarner, @hugoabernier, and @LuiseFreese - just checking in to see if you need any support on this article. Really looking forward to what you come up with as I can see a lot of overlap with the new "writing for the web" session that Sharing is Caring is working on. It would be great to include that dev guidance in addition to the business user focus.

eemancini avatar Nov 19 '21 17:11 eemancini