The instruction manual for the creation of is a large component software project. Unfortunately, it is often undervalued and remains to the end. But that does not mean that it should be without a good business plan.
It's tough. :
Documentation project
Article body:
The instruction manual for the creation of is a large component software project. Unfortunately, it is often undervalued and remains to the end. But that does not mean that it should be without a good business plan.
This is the first in a series of articles outlining the key elements of a good user documentation process. There are few projects that can implement all the steps, and some have additional steps. Nevertheless, it should provide you a good foundation (especially if you are not familiar with user document management).
Here is an overview of three articles.
Article 1 (this article)-to understand
• Identify your scope
• Familiarize yourself with the work environment
• Familiarize yourself with the product
• Identify the target audience of the document
• Specify target user requirements
* Estimate the duration and resources of the Doco project
• Research audience conditions
Article 2-Designation http://www.divinewrite.com/docoprocess2.htm)
• state your goals
* Write your conceptual specification
• Design some possible implementations
• Perform usability tests to prototype
• Write a specification of your requirements
• Estimated Project Period-Resources
• Test the usefulness of your writing sample conduct
• Write your job precs & design specs
Article 3-Writing (http://www.divinewrite.com/docoprocess3.htm)
Write * Doco
• Manage production
So go here ...
Understanding the project
Identify your scope
The first step in any project is to identify exactly what is expected. Generally, this happens before you work, but it should be the first thing you document. To understand the specific scope, there is no restriction between the whole development process or place, and the company is enclosed. Documentation projects are not just documentation, so it is important to know exactly what else is involved. Other areas in which people in the document generally need to be involved include:
• Spec examination
* GUI Review
• Product User Requirements Survey
• Document audience requirements survey
• Test of usefulness
All these things are integral to the development process and need to be properly planned.
Make yourself familiar with the work environment
Get to know everyone involved in the product. For software projects, this means project managers, designers, and people who do low-level coding. Make sure you have a really good relationship with them. They must respect you.
Get used to the product
Find out what's happening with the product. You need to keep track of:
• What is the goal of development
• Fully fulfilling your desires and needs
• How the product is used
• Who uses it
• What is the feature of the product
• How the product looks and feels
* Does it require a specific doco design? For example, it can only be run on the latest version of windows, it has a specific appearance, a specific environment (needs to integrate help), etc.
These are all you may have entered, either through simple critiques or input to user survey requirements. Reading, writing, and interviewing are available to many stakeholders. So as you go, so please be aware of the problem you need to identify, ask, or think about something.
Here are some (non-human) sources you can use to achieve this:
• Features and product specifications
• Project plan
• When it corresponds to a funding application
Identify the target audience of the document
Project manager (and other stakeholders and discussions with esp. Marketing) sensed user / audience.
Specify target user requirements
Make some educated guesses about the audience's requirements so you can provide an approximation of the product duration and resource requirements.
Project Managers (and other stakeholders) discuss esp. Marketing sees user's goal to look at tasks, users of mental models, products and other similar items when they are not aware of them Interview in-house experts to identify the goals, jobs, mental models, etc. done.
That is, document approaches, visual considerations, indexing considerations, and so on. ). Advocating over medium in minimalism is Nurnberg Funnel, an innovation research carroll edited by (1998).
Estimate Doco project duration and resources
At this stage, I do not know enough about the product or the viewer's requirements to know how long the document takes to complete, but this is a very rough estimate for everyone As long as we are aware that there is a possibility that further knowledge and research may change, it is OK.
This first quote should incorporate all of the time you spend on the stages that occur before and after the writing stage. Remember, these steps are important and should not be changed briefly. (Tip: In a well-managed project, the plan should take approximately 30% of your time, 50% writing, 19% production, and 1% rating.)
Estimate of pre-writing stage
Enabling the pre-writing phase is more elaborate than assigning for writing. In the stage of estimation, other evaluations that are the basis of the estimation, the above figures are a guide.
Write and post-write phase estimation
Since you probably do not know much about the product or user yet, your quote here starts in the next step with the goals and tasks you already specified.
1. Estimate the amount of work required to document the tasks users need to perform to achieve their goals.
2. Track previous doco records. See if you can see current quantity estimates and the time it takes to generate a doco similar to the past. The figure is derived based on this method.
3. Look at how this is compared to estimates derived from industry standard numbers (current industry standards allow one day per page of a document
4. Compare the two figures and decide a good compromise based on your experience and intuition.
5. Know how long you really have to do it and how many writers do you need to get it done in this time?
This project is a Microsoft project that uses a project implementation schedule. Remember to allow time for recruitment, training, and writing work practice.
Hint: At this stage, you need to write the first draft of the document project plan. The main items are as follows: All the steps of the reference are outlined in this document. Basically, it should reflect the process advocated here, but it is specific to the project you are working on. It is a timeline, such as whether it should be a thing.
Surveyor requirements
Research on product users and document readers is one of the most important parts of a successful product. Unfortunately, it is also one of the most overlooked aspects of any project. Although I feel the decision that this general agreement arose, I already have various functions such as that I already know, but only for the user.
When managing documentation projects, you need to look at opportunities for doing research. If the product life cycle is delayed, you need to ask if the user's survey has already been conducted on the product itself. Without it, you have a good chance of getting support for your audience's research.
The study of the audience is:
• User goals (what the user wants to achieve with the product)
* doco (manual user expectations? online help tutorials, conditions of availability, conditions of localization, etc.)
• The user's mental model (how to look at online help, an impression).
• User tasks (how users use the product to achieve their goals)
• Tasks performed by the user (user / task matrix)
• About these as a user?
• Which task is one off and which task is repeated?
• Did they change them?
• Do they do different tasks, or just a few?
• Do they hate doing it? (Is it boring and repetitive?)
• Are they difficult?
* Which task is considered essential?
• Are they normally when working under pressure?
• There are other distractions (environment, society, etc.)?
Some research methods to consider are:
• Observe the user working in the work environment
• Users in meetings with focus groups
•questionnaire
Hint: For more information on these methods, see Hackos (1994), Hackos & Redish (1998), Social Marketing: New Imperative For Public Health by Manoff (1985), Designing Quality Research 2nd Edition by & Rossman (1995), and Marshall Focus Group-First- Guide for Time Users ", Marketing Intelligence and Planning
To continue ... See Part 2 of this article (http://www.divinewrite.com/docoprocess2.htm) for information on your specific preparation.
Subcontracting for employment of employees
0 comments:
Post a Comment