Difference between revisions of "Documentation Framework"

Revision as of 22:38, 28 March 2023

Purpose

The purpose of this page is to describe the iDempiere documentation project. This page should help you update existing material and create new material in a way that is consistent with the success of the iDempiere project.

Planning and Organization

We meet weekly using mattermost using the Documentation Channel. Discussions are summarized and consolidated in the Documentation Discussion page.

Goals and Objectives

"Many hands make for little work" is a core principle of the group. We believe that everyone can contribute to documentation in one way or another. Our primary objectives are to:

Choose and support the the right tools to make it easy for everyone to contribute.
Educate and incentive everyone's involvement.

If we execute our objectives, we believe the following goals will be achieved:

Protect consumers' time and effort by providing accurate and succinct documentation
Create an inviting and efficient new user experience.
Identify solutions to common problems
Attract new users to the project
Flag material that might degrade the user experience

These goals and objective should create easily accessible, simple, consistent and accurate documentation.

Who We Serve

There are many actors in creating, maintaining and consuming documentation. Here are the identified documentation consumers:

Developer
Integrator/Implementor
Development operations (Devops)
Translator
Tester
Trainer
End-user project manager
End-user manager
End-user user

These same actors are ones who also create the documentation. Any actors can be a newcomer or a veteran.

Models and Standards

We use the Diataxis framework. Their website is pretty well organized. Quick summary video.

Categories of documents
- Tutorial (Learning-oriented): lessons that take the reader by the hand and provide a series of predefined steps to accomplish a goal.
- How-To (Task-oriented): directions that take the reader through the steps required to solve a real-world problem, these are intended for people that already know how to use iDempiere.
- Explanation (Understanding-oriented): discussion that clarifies and illuminates a particular topic.
- Reference (Information-oriented): technical descriptions of the machinery and how to operate it.

Getting Started - Cleaning the wiki

Did you find a page that could be improved, needs an update or should be removed? Please help us discover these pages by following these steps:

Sign up for an account in the wiki if you don’t have one: Request Account
Review standards and examples.
Consider posting your idea/thought on Mattermost (preferred) and/or the iDempiere google group. This helps ensure you understand what is currently available related to your change, and it invites the community to help support your efforts.
Use the wiki discussion page to formulate and aggregate your thoughts.
Click on Edit and add the corresponding tag to the page.

Documentation Links and Resources

@@ Line 28: / Line 28: @@
 # Translator
 # Tester
+# Trainer
 # End-user project manager
 # End-user manager