This site has an archive of a bunch of handouts talking about how to do digital documentation. It ranges from a variety of topics such as outlook, mircosoft office, adobe, and others. It's a very resourceful page to able to refer to.
This article does a good job at highlighting Microsoft's Word processor to use online documentation. The beginning seems more like an advertisement for Word but after digging in a little deeper you'll find some value.
Although this article is older, it gives relevent information on documentation and copyright for digital media. It outlines difficulties created by digital media such as P2P and file sharing. I found Chapters 2 and 5 helpful.
Here is a website from UMUC. There are twol links, "Digital Milenium Copyright Act," and "Digital Rights Management and Emerging Technologies" that provide multiple links to outside resources on topics regarding documentation/copyright issues.
The purpose of project 1 is to design a comic tutorial about a web base networking site. Business writing will help communicate the purpose and goal of the document to your readers. This article will assist me in writing clear, organized, strategic instructions on how to use the networking site. This is my favorite article.
This website give you good instructions on how to write instructions. haha! It gives you several links and PDF documents to browse on how to effectively communicate.
This web page discusses the fundmentals of document design which paralell with some of the concepts of "advanced page analysis" found on pages 36-37 of (Graham, 2005)
I found this website useful because it shows how to create grids in a word document to help align the text. It is broken down step by step which is very useful.
To be able to successfully and accuratly produce any kind of document it is crucial to be able to problem solve! This website is great being that it works well for problem solving publicly (people to people) and personally within the workplace.
Desaray K
http://managementhelp.org/prsn_prd/prb_bsc.htm
This is a great website to help one understand their learning style to help to be faster and more efficent when working with documents, researching, and especially when encountering problems and how to get those resoved fast!
Formal reports are used constantly in a professional environment to propose and discuss new ideas and designs. An official report has to flow well so the the ideas, designs, and text flow easily when presented to the right audience. It helps organize and structure thoughts to paper backed with data and other supporting documents.
Format distinguishes formal reports from an informal reporting of information. A well-crafted formal report is formatted such that the report's information is readily accessible to all the audiences
In a formal report, the audience expects a methodical presentation of the subject that includes summaries of important points as well as appendices on tangential and secondary points
Engineers and scientists write formal reports for many reasons, including the documentation of experiments and designs
Front Matter
The front matter to a formal report includes the preliminary information that orients all readers to the content of the report.
Front Cover. The front cover of a formal report is important. The front cover is what people see first.
Summary. Perhaps no term in engineering writing is as confusing as the term "summary."
Contents Page. The table of contents includes the names of all the headings and subheadings for the main text.
Title Page. The title page for a formal report often contains the same information as is on the cover.
Main Text
The text portion of your formal report contains the introduction, discussion, and conclusion of your report.
Introduction. The introduction of a report prepares readers for understanding the discussion of the report.
Discussion. The discussion or middle is the story of your work. You do not necessarily present results in the order that you understood them, but in the order that is easiest for your readers to understand them.
Conclusion. The conclusion section analyzes for the most important results from the discussion and evaluates those results in the context of the entire work.
Back Matter
The back matter portion of your report contains your appendices, glossary, and references.
Appendices. Use appendices to present supplemental information for secondary readers.
Glossary. Use a glossary to define terms for secondary readers. Arrange terms in alphabetical order.
References. Use a reference page to list alphabetically the references of your report.
This website discusses the format and purpose of a formal report. The different kinds of professionals that use this report need to know who the intended readers are.
This website is a good reference to use when writing a formal report because it lists all of the components required in a report and it also provides helpful samples to look at.
This site describes the difference between informal and formal reports.It also discuses the details such as font matter, front cover, title page, content page, summary, conclusion, etc. Sample reports are viewed on the left hand side of the site.
This website contained a lot of information that just gave an overview on the basics of formal reports. It also explained how formal reports differ from an informal way of reporting information. It also split a formal report into 3 sections that I did not see in the other website I found. In this one it states that there is front matter, main text, and back matter. Each of these contains different sections within as well. Very helpful for when we have to work on Project #3!
I like this website because it gives you good explanation on different things you need in a good report. It talks about the front matter like front cover. tittle page, contents page and summary. Also about the main text like introduction, discussion, conlcusion. Back matter is also important with the appendices and glossary.
The UNESCO as mention in the book 'Technical Communication in the 21st century,' page 106, is a good source to find literacy rates in other countries that can influence a workplace writer's appoach toward a given document, however it is also a good source to learn about cultures. Achieving a better understanding of other cultures and learning to respect and their believes is key to effective transnational communication.
this was the best example i found about documentation because it not only explains to you what it is but how to do it. it makes it simple and breaks down everything into pieces so that you can see all the parts that aqre in cluded it it. this website also informs you about how it works in management.
I think this website is a good tool because it teaches you how to cite a website. I may need to cite a website in my Glog or blog or anywhere else so this is very helpful.
I found chapter 3 of this document useful. It gives you common elements of good writing, do's and don'ts of writing styles and usage. All of the chapters are relevant for this project and provide a checklist at the end of each.