# data[].attributes.headline
Replying to Video Content - Juan (by Martine)

# data[].attributes.subject
Replying to Video Content - Juan (by Martine)

# data[].attributes.body
"It was fairly surprising to learn that screen captures don't always improve a document's technical effectiveness." - Juan

I agree with what Juan commented. I was surprised at the fact that we can use screen caps in order to clearly explain the writing. However I also learned that we have to make sure it is needed and clearly visualized. We do not need to clutter the document with pictures for nothing. - Martine

# data[].attributes.body
After watching the video content, I was surprised about the screen capture section. It was an idea that never crossed my mind. However, I will use it within my future technical documents when necessary.

-Martine Lavoie

# data[].attributes.body
There are many tricks in order to help with technical writing. In my understanding, there are a few key components required in order to have a proper technical writing document.

Have a plan for the structure.  why are you making this document, who is this document for, what is this document about, etc.

Technical writing should be clear, understandable and simple.

Using separate sections, titles and even a table of content in order to make reading simple.

Be consistent with key words, same word for technical use.

Reread your document as if you are the client, trying to understand the how's.

-Martine Lavoie

# data[].attributes.body
One of the first things you should do to ensure that you are writing a good technical document is to come up with a good outline that follows a logical progression and doesn’t jump around unnecessarily.  This will help to ensure that each new section builds on the previous sections and that the reader won’t have to jump ahead to another section to understand the section he is reading about.

# data[].attributes.body
A good technical document should use the simplest terms that your target audience understands. So know who you are talking to and basically make the technical quickly understandable.

# data[].attributes.body
I guess what surprised me the most was the lack of supporting documentation in the reports. I was always of the opinion, the more you include in a report the better.

# data[].attributes.body
The thing that seemed most important to me would have to be organization of your thoughts

# data[].attributes.body
This video reminded that I should always consider who I am writing for and that the people who will read the documents may not always be apart of the IT community.

# data[].attributes.body
My ideas on writing a good technical document would be to make sure it is using terms in which the audience will understand without any problems. It is important to keep it as short and simple as possible to save time to the readers.

# data[].attributes.body
I agree that organization is key in the documents so that any user will be able to quickly and effortlessly find the section they are looking for.

# data[].attributes.body
https://m.youtube.com/watch?v=Lw4TKCsIumQ

# data[].attributes.body
The part of the video that resonated with me the most was the section about using screenshots.  When I worked for the government I wrote a manual on how to use the software that we were using to scan and code documents.  My manual included many small screenshots of the specific button or field that was being described. The people that used the manual found the screenshots to be helpful

# data[].attributes.body
I was surprised that the author of the video said to not always provide screen captures. I would of always thought that it would've been the most effective method to explain something.

# data[].attributes.body
The information that resonated with me from the author is when he explained to always use the same terminology throughout the document as I believe this is crucial.

# data[].attributes.body
This is a good point Ryan. It can be hard to put yourself in other people's brains.

# data[].attributes.body
This video reminded that I should always consider who I am writing for and that the people who will read the documents may not always be apart of the IT community.
I agree with Alex’s thoughts on the audience that is viewing the documents. It is crucial to have precise and clear explanations as not everyone will understand technical language/jargon. – Cat Murray

# data[].attributes.body
To create proper documentation, you must create the document to be clear and concise information without any jargon.

# data[].attributes.body
I think that a good way to make sure you are writing a good technical document is to try using your document as if you are the user. If you are able to achieve your goal then the document is understandable. You could also have a user with less experience to try using it as well.

# data[].attributes.body
The part that resonated with me is the usage of screenshots. I am kind of person who likes to explain things by using examples. I think it easier to user to understand it that way

# data[].attributes.body
Users judge the quality of product, s/w based on the quality of documentation.

Quality states the measure of accuracy (absence of errors), like typos, spellings, punctuations, incorrect data.

Usability defines clear and accurate information.

Is the content standalone?

Can someone use it?

Do you understand what you are writing?

Is the information misleading or ambiguous?

# data[].attributes.body
Keep your info organized and ensure your info is all relevant.

# data[].attributes.body
The part of the video that resonated with me most was making a table of contents. I find it is a good idea, because you can let the readers know if what they are looking for is in your document or not quickly.

# data[].attributes.body
https://www.prismnet.com/~hcexres/textbook/models.html#tech_specs

# data[].attributes.body
http://idratherbewriting.com/2010/09/10/40-foundational-books-for-technical-writing/

# data[].attributes.body
https://medium.com/technical-writing/how-to-become-a-technical-writer-48e77383b5a6

# data[].attributes.body
https://www.google.ca/url?sa=t&source=web&rct=j&url=http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf&ved=0ahUKEwiZmdjuiJbWAhVD94MKHQT3AhAQFggkMAA&usg=AFQjCNEYWAb0YpgXkSTyKe9yPBa2VJfSkg

# data[].attributes.body
To me making a good technical document requires being clear and to the point with little to no ideas left to the reader's imagination.

# data[].attributes.body
http://writing-skills.com/how-to-approach-technical-writing

# data[].attributes.body
http://idratherbewriting.com/2014/06/20/10-technical-writing-principles-to-live-by/

# data[].attributes.body
The part of the video that resonated most with me was about the importance of the table of content. I have had many bad experiences with manuals and other documents that did not have a good table of content and they where difficult to use. It made them hard to use and left me not very happy with the company behind it.

# data[].attributes.body
To make good technical documentation you have to make it without any unecessary fluff into it. Do not use adjectives or other words that will lengthen the documentation without adding anything of real importance to it. It should only provide the information that is needed by the document and nothing else.

# data[].attributes.body
http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf

# data[].attributes.body
The item from the video that most resonated with me was when it was mentioned how the same word should be used again if you are referring to the same thing as before. This can be confusing for example when people use the term PC to refer to a computer running only a Windows operating system. A "PC" could have an alternative operating system installed on it

# data[].attributes.body
Make sure that the document is focusing on the subject and provide only a relevant information or data. Try to provide at least one example or screenshot. In addition, try to check the information before writing it in order to prevent providing a wrong data or information to the users

# data[].attributes.body
I agree with this I had not put any thought into this before the video. However, I can see now how important it is to be consistent in using the same words.

# data[].attributes.body
It was fairly surprising to learn that screen captures don't always improve a document's technical effectiveness.

# data[].attributes.body
I was surprised about the screen captures portion of the video. This is because the point of technical writing is to keep it shot and simple, so I didn’t think images would be accepted. However it makes since because images can explain somethings quicker than words could.

# data[].attributes.body
http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf

# data[].attributes.body
http://www.wikihow.com/Master-Technical-Writing

# data[].attributes.body
Make sure that the project has documentation for both beginners and experts.

# data[].attributes.body
http://docs.readthedocs.io/en/latest/index.html

# data[].attributes.body
https://renziebaluyut.wordpress.com/2008/09/29/10-tips-for-effective-technical-writing/

# data[].attributes.body
Do not use a term which demands an explanation beyond the scope of what you are trying to convey. Combine larger thoughts into simpler, easier to understand points.

# data[].attributes.body
https://www.writerswrite.com/technical/resources/

# data[].attributes.body
http://www.wikihow.com/Improve-Your-Technical-Writing-Skills

# data[].attributes.body
What resonated with me was keeping everything as organized as possible. It makes sense and keeping things as easy to understand as possible is key.

# data[].attributes.body
https://medium.com/@limedaring/five-tips-for-improving-your-technical-writing-and-documentation-47353723c8a7

# data[].attributes.body
Share a link to a site that has relevant information on technical writing. One that your peers and yourself could use as an upcoming resource.

# data[].attributes.body
In reply to: Ideas (Andrew)

I agree completely with what Andrew mentioned. If you use jargon that someone will need to research in order to understand it, that is wasting their time. Try to only include information that someone new to a topic may easily understand, and if more knowledge is required, include appendices.

# data[].attributes.body
Link to 'Technical Report Writing Tips'
http://courses.washington.edu/ehuf462/462_mats/technical_report_writing_tips.pdf

# data[].attributes.body
What surprised me the most about the video was the tip of “Be Succinct”. Whenever I think about report or document writing, I think of long, drawn-out documents that are a pain to read. For the purpose of conveying relevant information though, having to skim through unnecessary information is a waste of time. Having a more concise document will help the audience grasp its content, rather than overwhelming them with information.

# data[].attributes.body
Detail your own thought or idea on how to ensure you write good technical documents. Research online if required

# data[].attributes.body
To ensure I’ve written a good technical document, I’ll make sure to have a good outline made prior to writing. If I have an idea on what the end product will look like, it’ll make the writing easier, especially if it is broken down into different sections.

Another good practice is to know your subject well. If you’re unsure of your topic, it will be challenging to convey your message to your audience.

Lastly, using a good layout with proper grammar and punctuation, will help create a good technical document. If your work is riddled with spelling errors and your thoughts are scattered everywhere, it makes it difficult to interpret for readers.

# data[].attributes.body
I believe that the two most important factors in good technical writing is organization and clarity. These are both important as without them the user will not be able to find where the information is located, and when they do find it it may not be helpful.

# data[].attributes.body
What item resonated or surprised you the most and why?