Impact resume. Geometric resume. Swiss design resume. Explore premium templates. Event planner. Photo calendar. Service invoice Green Gradient design. Always remember that your technical documentation is for the user. Especially when the subject matter is dense, technical, or complicated. Giving feedback is a skill in itself. Ask a project stakeholder or someone outside the project to go over your documents and pick out anywhere they get lost or confused.
But always remember to keep the user front of mind. Good writing comes down to editing. With your feedback and revisions in place, break out your style guides and either edit the documentation yourself or take it to a technical editor who can make sure the language has a logical flow and is consistent throughout. Whenever possible, you should try to get a second set of eyes on your content.
Planio wikis are especially powerful for editing with version control, history, and roles and permissions to make sure you and your team stay on top of who's written and edited what. Start with a simple safety check. As part of the safety check, you should make sure to revisit the topics on basic functionality and terms explained as these are the core of your documents and should be precise.
Next, do a navigation audit. Remember that your document structure is key. Are users getting lost or confused? Are they not getting the answers they were looking for or thought they were getting based on headlines or navigation?
Take the time to work with outside testers to make sure that when real users come to your documents, they leave happy. But if you think your job is finished, think again. Includes information on XEN and VirtualBox written for the other admin at work, some specific information but easily extrapolated.
An overview of our backup and disaster mitigation and recovery plans as well as personal IT assessment and suggestions. Probably the least useful of the documents included, but possible useful to some.
An Executive summary regarding research and recommendation of off-site backup solutions to complement or replace our current on-site tape backup strategy.
More or less an executive summary to explain what the cloud really means to IT people when it is used as a marketing term. He also asked I thank Martin from the community who provided links in the thread that were invaluable to HUW when he wrote this document.
Thank to NeighborhoodIT we now have another How-To with an example IT consulting contract fro those of you who run your own business on the side or full time! AUP definitely needs be renewed periodically, hence more the requirement for a separate form. Hmm, and HR issue as it is. DR overview is a good add. It is a start on a disaster recovery plan, business continuity plan, and business impact analysis plans. IT documentation examples and templates.
Alex This person is a verified professional. Verify your account to enable IT peers to see that you are a professional. Last Updated: May 22, 1 Minute Read. Reply Facebook Twitter Reddit LinkedIn.
0コメント