Documentation Blueprint

This Wiki is read-only for reference purposes to avoid broken links.

This page aims to generate some discussion on critical initial questions. We realize that these are not the only questions that will arise during the planning phase of this document; however, we feel that this is a good place to start. We have posted some initial responses but look forward to your participation and input.

What? (In one sentence how would you define this document?)

• A complete and robust document for the typical end user of ADempiere. - Joseph.brower

• Some series of contextually written tutorials perhaps? - Red1

Do you mean like scenarios? If we were to give "real world" examples that could really benefit the readers of the documentation. Joseph.brower 22:08, 18 January 2008 (EST)

• A document that also helps making a decision towards Adempiere - Mario Calderon

• A set of documents for different purposes - admins, CEOs, daily Users ... - Georg Schütz

Who? (Who is the primary audience of this document?)

• We think that the ideal audience for this manual is non-technical managers of organizations and companies. - Npsglobal
• I agree. We can't have this manual be written for technical people. The simpler we make things to follow, the better. - Joseph.brower
• Looking at the context of freebies, many will be uncertain starters in a DIY (Do It Yourself) fashion. If such manuals make them feel at home then we have a winner - Red1
• Managers/freelances who are comparing the capabilities of the different ERPs - Mario Calderon
• Consulting and service companies who like to step into the ADempiere market having problems to understand ADempiere in a non-technical way

Why? (What is the primary purpose of this document?)

• To allow anyone, even people from small shops in non-technical fields to properly and efficiently use ADempiere. Joseph.brower
• ERP is a complex field, there can be a host of whys. Perhaps the most basic is to answer if this ERP is ready for the user or vice versa. Perhaps ther can be a nice laid-out requirements checklist that is progressive. - Red1

How? (How can we most efficiently create this document?)

• We think that there really are five basic steps to creating each section of this document as well as the entire document. See the File:ADempiere Doc Project.pdf that we have posted. - Npsglobal

• My 'HOW?' will be as in what mode can we house or develop our work, using the Wikimedia approach where simple and active peer review can occur. - Red1

What other questions should we be asking as we start?

• Perhaps we should set up a group of target languages so that translation can be done while we're working on the core documents.Joseph.brower
  • If so, then German, Spanish can be the reachable targets. - Red1
  • Regarding the german manual I would like to point you to http://sourceforge.net/forum/message.php?msg_id=4742199