So your understanding and project manual and specced. Now you are ready to write. Here are some tips that will help in your way. This article is not about the actual writing itself; it is about going along with the writing. (Information about writing online help is www.divinewrite.com/helpfulhelp.htm.)
It's tough. :
Documentation project
Article body:
So your understanding and project manual and specced. Now you are ready to write. Here are some tips that will help in your way. This article is not about the actual writing itself; it is about going along with the writing. (Information about writing online help is www.divinewrite.com/helpfulhelp.htm.)
Note: This is a series of final articles outlining the key elements of a good user document process. (To read the first and second articles in this series, go to http://www.divinewrite.com/docoprocess1.htm and http://www.divinewrite.com/docoprocess2.htm.)
Indexing
Index keywords must be defined during topic creation. At the moment, the subject is clear in the mind of the author and very familiar with all of the intricate details. It has a stage at the time of indexing and is proposed as part of the review of keywords.
Some authoring tools do not make this kind of approach particularly easy (for example, allowing multiple authors to access files needed for indexing (some authoring tools actually do this for the reviewer) It may be easy.) TIP: For more information on the index, see The Art of Index by Bonura (1994).
User document review
The user's documents to make it technically correct and easy to read are a lot of intellectually reviewed people. For software projects, your review list will be subject matter experts (generally programmers), software architects, maybe project managers, your review requirements will vary from draft to draft, so reviewers and review procedures should be documented in practice. need to do it.
User document test
Tests can be run at different levels:
• Each writer can use the exam's own user's documents in the following. But remember, this kind of test actually wrote them, as there is a tendency for the writer to follow the instructions as to think that they wrote them,
* The second level is for tests performed by other writers ... as part of a peer review.
* The third level is for the inspection department to do formal testing on user documentation. Although this type of testing does not happen often, it is good to realize it.
* The fourth level should be conducted as part of beta testing, see Managing Documentation Project by Hackos (1994), pp. 452-453.
No matter what level of testing you use, documented tasks apply to the product and you need to design your online help to function properly. In order for the user document to pass the test, it is necessary to meet the goals specified at the beginning of the project.
Localization of User Documents
Localization is often considered post-write activity, but is best done as part of the write phase. The exact timing may differ from project to project, but the rule of thumb is to have translators work on a second draft (but the draft: Hint: most translators send individual topics to them You will prefer to work with a significant amount of user documents, rather than
And localization, stage, balance. Sending user documentation too quickly to translators can cost a lot of translation changes. If you send it too late, you are not ready to be in time for the release of the product.
Change management
It is important to minimize the impact of product or development schedule changes. To do this, we need to develop the following approach:
1. Identify the change
2. Estimate the impact on time and / or resources *
3. Notify Project Manager
* You can use the same estimation techniques you used earlier in the project.
Track write progress
It is important to note that the writing phase is simply not about writing. If you track your progress at every step along the way, make sure you meet your milestones and deadlines (Continuous for easy access with records of all projects taken Maintenance and future project references.)
You need to track the time taken to perform all the steps described in this procedure, each draft stage, review time, total time taken, etc.
Regular team meetings
Regular team meetings should be held to communicate progress to all team members. These meetings should be a forum for looking at your tracking metrics and discussing the full estimated percentages for various topics currently in progress, rather than the time the estimated completion rate has already been spent If low, you can act on it. These meetings make it possible to identify the writing progress connector.
Create a progress report
Your management also needs to keep track of project status. You need to write a regular progress report outlined:
• Project location
• What have you done over the last month
• Are you planning to do over the next month
• Any problem you encountered
Production control
The meaning of "production" depends on the type of document you are working on and who your audience is. But coverage:
•printing
* Join
• Product build (if help was compiled into the product)
The production phase generally needs only management, but you still need to spend a fair bit of time on people in production and reinforcement and liaising.
Project evaluation
The purpose of the evaluation phase is to consider:
• Did the project proceed as planned?
•why? /why?
• The entire project that contributed to the individual team.
• Do project manager.
* Whether the document has achieved its goal.
Your tracking metrics will be helpful during this phase; if there is a defect in the project progress, you should go the way towards identifying them. You can also use the sample evaluation reports provided by Hackos to manage document projects according to Hackos (1994), pp. 514-518.
Did you succeed in writing?
Now that you have created and released the documentation, you need to determine if the goals have been achieved. The only way to do this correctly is to do further research of the user.
Hint: For more information on research methods, see Hackos (1994), Hackos & Redish (1998), Social Marketing: New Imperial For Public Health by Manoff (1985), Designing Qualitative Research 2nd Edition by & Rossman (1995), and "Marketing Intelligence and Planning by Tynan & Drayton Marketing (1988)-In
And that's it! Remember, this process is the "ideal" process. Take a bit suitable for you and your project and leave a bit.
Good luck
Successful Document Project-Part 2 3- 'Designation'
Management project is a project. You know who your audience is, what they are trying to achieve, how the product accomplishes it, and what the audience needs help Now is time to guess your intentions .
It's tough. :
Documentation project
Article body:
Management project is a project. You know who your audience is, what they are trying to achieve, how the product accomplishes it, and what the audience needs help Now is time to guess your intentions .
Note: This is the second in a series of three articles outlining the key elements of a good user documentation process. (To read the first and third articles of this series, go to http://www.divinewrite.com/docoprocess1.htm and http://www.divinewrite.com/docoprocess3.htm.)
State your goals
Generally speaking, your goal statement should indicate that you want to create a series of document products that meet the audience's requirements. Specifically, you have a number of sub goals. (Tip: It's a goal you put here to measure your product's success by your own in-house testing, and also by the research of your evaluation users) For such sub-goals:
•ease of use
* Availability
•Usefulness
*Accuracy
•Relevance
* Comprehensiveness
• Comply with style guidelines
• Correct spelling and punctuation
Describe the conceptual specification
0 comments:
Post a Comment