ADempiere

Documentation Project Management

ADempiere Documentation Project The Project Plan

The project plan is a coherent and consistent protocol that guides both the execution and the control of the project. The project plan addresses these questions: What is the overall Definition of the Project? What is the proposed Design of the Project? How will the Project be Developed? How will the project be Delivered and Maintained ?

ADempiere Documentation Project

Create a Manual
1. Define 2. Design 3. Develop
4. Deliver & Maintain

1.1 Final Product: What 1.2 Audience: Who 1.3 Purpose: WHY 1.4 Process: HOW

2.1 Structure & Format 2.2 Style

3.1 Draft

Revise Rewrite
3.2 Add Graphics & Other Aids

2.3 Content

State Specific Tasks & Topics

3.3 Edit

ADempiere Documentation Project

Create a Manual
1. Define
1.1 Audience: WHO?
1.2 Final Product: WHAT? WHO? 1.3 Purpose: WHY 1.4 Process: HOW

Define

Adempierre Documentation Project

Audience: Who?

Who? All Documentation will be written with a specific audience in mind The Primary Audience for this manual is a manager who is intelligent, but technically uninformed.

ADempiere Documentation Project

Create a Manual
1. Define
1.1 Audience: WHO?

1.2 Final Product: WHAT?

1.3 Purpose: WHY 1.4 Process: HOW

Define

ADempiere Documentation Project

Final Product: What?

What? A Users Manual that will be used for ???????????????????? This manual will also ???????????????????

ADempiere Documentation Project

Create a Manual
1. Define
1.1 Audience: WHO?

1.2 Final Product:

1.3 Purpose: WHY 1.4 Process: HOW

Define

ADempiere Documentation Project

Purpose: WHY?

Why? The primary purpose of this manual is ?????? This manual will also be used for ???????????????????

ADempiere Documentation Project

Define

Audience

Purpose

Process: How

Five Basic Parts of Each Section

SOP for the Process: Six Basic Steps

Interaction within the Community

Order of Completion

ADempiere Documentation Project

Define

Audience

Purpose

Process: How

Five Basic Parts of Each Section

SOP for the Process: Six Basic Steps

Interaction within the Community

Order of Completion

Define

ADempiere Documentation Project

Process: How

Five Basic Parts of Each Section

Each major section of the Documentation will include the following elements:

Introductory Material that presents a clear overview and preview of the entire section, shows how that section relates to previous sections, defines any important terms specific to that section, relays any important warnings for that section, describes the specific way that the section will be structured Subsections that preview the operational steps Operational steps in which the audience performs some specific procedure; each operational step will be clearly distinguished from explanations, notes, or examples As often as feasible, helpful graphics, examples, and explanations A Troubleshooting Guide to respond to any potential glitches the audience may encounterwith suggestions to solve those problems

Define

ADempiere Documentation Project

Process: How

SOP for the Process

All Documentation will include specific milestones with timelines, and each new section of a document will be written according to the following process: Complete a brief Draft of a Documentation Worksheet, including the specific purposes to be accomplished with that section; specific process to be followed for that section; any particular problems that will need to be considered in documenting that section, as well as the initial outline expected for the section Invite all members of the Bazaar community to contribute to the creation of this Documentation Worksheet Post a Final Documentation Worksheet for that section or milestone (though it may be adjusted as future needs demand) Create a more detailed Outline of the sectionand again invite feedback Create a Draft for each part of the outlinefollowing the same procedure of input, feedback, and finalization Develop the Final Draft of the outline into the final version of the section, including introductory material, graphics, explanatory material, and examples

Define

ADempiere Documentation Project

Process: How

Interactions within Community

People are more important than deadlines, money, or efficiency. A successful project means little if it leaves a trail of broken friendships and shattered integrity. With that in mind: All comments and interactions within the writing community will be given and received with the same sense of respect, compassion, and ethical integrity that we seek to relay to our primary audience. Specifically, all comments given will be assumed as helpful criticisms and not as personal attacks or jabs. We will just assume that any feedback will be prefaced by the following phrase: I am not trying to offend anyone or create bad feelings, but I would like to offer the following suggestion . . . And if you decide not to accept these suggestions, that is fine with me. And we will also assume that any feedback will be received with the following thought implied: Thanks for speaking straight and offering these criticisms; the project will be better for your inputeven if I have to adjust my presumptions to appreciate and implement your ideas. Lets have fun with this. What a great opportunity to work together and get to know such fine and interesting people, and to work together on such a worthwhile project that has the potential to do a lot of good for a lot of people. All revisions and edits will be posted according to the following guidelines: ?????

Define

ADempiere Documentation Project

Process: How

Order of Completion

All Documentation will include specific milestones with timelines, and each new section of a document will be written according to the following order of completion??????:

1) 2) 3) 4) 5) 6)

Accounting Systems Inventory Systems On-Line Payment Systems Web-Site Development Protocol Marketing Decisions Management Options

ADempiere Documentation Project

Create a Manual
1. Define 2. Design 3. Develop
4. Deliver & Maintain

1.1 Final Product: What 1.2 Audience: Who 1.3 Purpose: WHY 1.4 Process: HOW

2.1 Structure & Format 2.2 Style

3.1 Draft

Revise Rewrite
3.2 Add Graphics & Other Aids

2.3 Content

State Specific Tasks & Topics

3.3 Edit

ADempiere Documentation Project

Create a Manual
2. Design
1.1 Structure and Format
1.2 Style

1.3 Content
1.4 Specific Tasks and Topics

Design

ADempiere Documentation Project

Style

What? A Users Manual that will be used for ???????????????????? This manual will also ???????????????????

Define

ADempiere Documentation Project

Final Product: What?

How?
All Documentation will be written in language that is simple, familiar, and concrete. The target tone for the document may be best described as conversational, and the quality standard for that tone is: Does this sentence sound right if I speak this aloud to a friend who is not familiar with this project? Besides accuracy (logos), the document should also present a sense of empathy for the audience (pathos) by treating that audience with respect and compassion (i.e., as a living, breathing human and not a faceless operator), as well as a high sense of ethical integrity (ethos) from the writers (demonstrating the writers competence, fairness, and good will).

Design

ADempiere Documentation Project

Content

What? Content This manual will contain ???????????????????? This manual will also contain ???????????????????

Design

ADempiere Documentation Project

Specific Tasks and Topics

What? Tasks and Topics Some of the tasks for each section are ???????????????????? Some of the tasks for each section are ????????????????????