From 221d5d9190200bb16336fd0a707edc9ad7194988 Mon Sep 17 00:00:00 2001 From: Cathie Date: Thu, 16 Mar 2017 20:37:18 -0400 Subject: [PATCH 1/5] fhhfhfhf fhjfhfhfh --- concept-example.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/concept-example.xml b/concept-example.xml index eb78822..6655f54 100644 --- a/concept-example.xml +++ b/concept-example.xml @@ -15,5 +15,6 @@

First paragraph

Second paragraph

+

One word

 \ No newline at end of file From 31976d719f0feb29d61d802248e2dcb4d28ff4e4 Mon Sep 17 00:00:00 2001 From: Cathie Date: Thu, 6 Apr 2017 13:23:09 -0400 Subject: [PATCH 2/5] Changed RST to DITA --- DITA-CH.xml | 61 ++++++++++++++++++++++++++++++++ DITA-CH4-reference-example.xml | 19 ++++++++++ DITA-CH4-task-example.xml | 35 +++++++++++++++++++ DITA-CH4.xml | 61 ++++++++++++++++++++++++++++++++ DITA-CH6.xml | 64 ++++++++++++++++++++++++++++++++++ DITA-CH9.xml | 34 ++++++++++++++++++ concept-example.xml | 14 ++++---- reference-example.xml | 18 ++++------ task-example.xml | 24 ++++++------- 9 files changed, 301 insertions(+), 29 deletions(-) create mode 100644 DITA-CH.xml create mode 100644 DITA-CH4-reference-example.xml create mode 100644 DITA-CH4-task-example.xml create mode 100644 DITA-CH4.xml create mode 100644 DITA-CH6.xml create mode 100644 DITA-CH9.xml diff --git a/DITA-CH.xml b/DITA-CH.xml new file mode 100644 index 0000000..ca6e37c --- /dev/null +++ b/DITA-CH.xml @@ -0,0 +1,61 @@ + + + + + + + Cathie Ryan + Chapter 4: Writing Collaboratively + Summary of Chapter 4 contents about writing collaboratively. + +

Technical writers are often employed by corporations and assigned to work on team to produce + documentation.

+

In these corporations, it is necessary for the writer to know how to collaborate with the + team.

+

When collaboration is done correctly, the documentation is better.

+

Our text book lists several advantages and disadvantages to collaboration. With + collaboration,

+

the writer can draw upon a wider knowledge and skills base. The documentation also benefits + by having

+

another person review it to make sure that it is accurate, clear, and targeted to the + intended audience.

+

Also, collaboration improves communication in the team, acclimates new writers, and improves + moral.

+

Collaboration does have disadvantages in time, interpersonal conflict, and other areas. + However, if

+

the writer conducts themselves in a professional manner, the disadvantages of collaboration + are manageable.

+

Documentation projects benefit from being planned and monitored through the process. Before + writing

+

begins, it is advisable to create a documentation plan that lists what will be written, by + whom, and

+

contain a detailed schedule with milestones such as the date when the document will be + drafted, reviewed,

+

published, and so on. Some documentation plans may include a list of risks or dependencies + that detail

+

the circumstances that impact successful completion of any and all milestones. Also, if the + documentation

+

is being written by many writers, it is best to define individual tasks for each writer and + establish a style

+

sheet, a glossary as well as the work schedules and procedures to coordinate the team’s + efforts.

+

In the career of technical writing, writers will have to attend many meetings. To be + successful,

+

the writer should be prepared for the meeting with appropriate questions, listen effectively, + and give

+

feedback. It is important to be professional and diplomatic when giving feedback.

+

Lastly, technical writers need to understand the various social media services available.

+

For example:

+
    +
  • Videoconferencing as a way to meet and share information.
    • +
  • Online information sources such as tweets, wikis, websites, Facebook, YouTube, and + more.
    • +
  • Different types of writing (aka authoring) software and online review.
    • +
+ + \ No newline at end of file diff --git a/DITA-CH4-reference-example.xml b/DITA-CH4-reference-example.xml new file mode 100644 index 0000000..bc86f10 --- /dev/null +++ b/DITA-CH4-reference-example.xml @@ -0,0 +1,19 @@ + + + + + + + Glossary of Terms + From Technical Communication by Mike Markel. + +
+ Audience Profile Sheet +

A document that records characteristics of the audience. For example, the audience profile + sheet could include education level, job responsibilites, type of work environment, cultural + characteristics and many more.

+
+ + diff --git a/DITA-CH4-task-example.xml b/DITA-CH4-task-example.xml new file mode 100644 index 0000000..1372803 --- /dev/null +++ b/DITA-CH4-task-example.xml @@ -0,0 +1,35 @@ + + + + + + Writing Process + From Technical Communication by Mike Markel. + + +

Typical steps when writing technical documentation.

+ + + + Planning + + + Drafting. + + + Revising. + + + Editing. + + + Proofreading. + + + + \ No newline at end of file diff --git a/DITA-CH4.xml b/DITA-CH4.xml new file mode 100644 index 0000000..ca6e37c --- /dev/null +++ b/DITA-CH4.xml @@ -0,0 +1,61 @@ + + + + + + + Cathie Ryan + Chapter 4: Writing Collaboratively + Summary of Chapter 4 contents about writing collaboratively. + +

Technical writers are often employed by corporations and assigned to work on team to produce + documentation.

+

In these corporations, it is necessary for the writer to know how to collaborate with the + team.

+

When collaboration is done correctly, the documentation is better.

+

Our text book lists several advantages and disadvantages to collaboration. With + collaboration,

+

the writer can draw upon a wider knowledge and skills base. The documentation also benefits + by having

+

another person review it to make sure that it is accurate, clear, and targeted to the + intended audience.

+

Also, collaboration improves communication in the team, acclimates new writers, and improves + moral.

+

Collaboration does have disadvantages in time, interpersonal conflict, and other areas. + However, if

+

the writer conducts themselves in a professional manner, the disadvantages of collaboration + are manageable.

+

Documentation projects benefit from being planned and monitored through the process. Before + writing

+

begins, it is advisable to create a documentation plan that lists what will be written, by + whom, and

+

contain a detailed schedule with milestones such as the date when the document will be + drafted, reviewed,

+

published, and so on. Some documentation plans may include a list of risks or dependencies + that detail

+

the circumstances that impact successful completion of any and all milestones. Also, if the + documentation

+

is being written by many writers, it is best to define individual tasks for each writer and + establish a style

+

sheet, a glossary as well as the work schedules and procedures to coordinate the team’s + efforts.

+

In the career of technical writing, writers will have to attend many meetings. To be + successful,

+

the writer should be prepared for the meeting with appropriate questions, listen effectively, + and give

+

feedback. It is important to be professional and diplomatic when giving feedback.

+

Lastly, technical writers need to understand the various social media services available.

+

For example:

+
    +
  • Videoconferencing as a way to meet and share information.
    • +
  • Online information sources such as tweets, wikis, websites, Facebook, YouTube, and + more.
    • +
  • Different types of writing (aka authoring) software and online review.
    • +
+ + \ No newline at end of file diff --git a/DITA-CH6.xml b/DITA-CH6.xml new file mode 100644 index 0000000..8fbaa81 --- /dev/null +++ b/DITA-CH6.xml @@ -0,0 +1,64 @@ + + + + + + + Cathie Ryan + Chapter 6: Researching Your Subject + Summary from Technical Communication by Mike Markel. + +

The main purpose of searching a subject is to get answers to questions. You may need an + answer to a

+

practical question such as “Should tablets replace notebooks in the workplace?”. + Alternatively, you may

+

need to answer scholarly questions. Whether you are searching for answers to practical + questions or

+

scholarly questions, your research will fall into two main types:

+
    +
  • Primary research—research where you discover or create the information yourself.
    • +
  • Secondary research—you find information that other people have discovered or created.
    • +
+

Good research is planned. The audience, purpose, and subject need to be analyzed to narrow + down the

+

scope of the project. Budgets, time schedules and the form of the final documentation need to + be worked out.

+

You will essential to determine how much to research, how much research will actually be + summarized in the

+

document, and how much research is needed to provide you with enough background knowledge + that you can

+

understand and write to your audience.

+

Before you start researching, it is helpful to write out the questions that you need to + answer.

+

Then you will need to be persistent to find the answers to your questions. You will want to + have a system

+

for recording or managing the information that you find. Finally, you will want to make sure + that you have

+

triangulated the information. That means that you found 3 different sources that answer the + question in

+

three different ways.

+

You can find information in traditional form, online social media, or forms that you + generate yourself:

+
    +
  • Traditional form includes print, online databases or catalogs, reference works, + periodicals, newspapers,
    • +
  • abstracts, and government information.
    • +
  • Online social media includes online discussion boards, wikis, blogs, tagged content, and + RSS feeds. You
    • +
  • will need to evaluate the information that you find for accuracy, bias, completeness, + appropriateness,
    • +
  • clarity, and timeliness.
    • +
  • Forms that you generate yourself include observations, field research, inspections, + demonstrations
    • +
  • (as the case with software programs), interviews, questionnaires, inquiries, and + surveys.
    • +
  • Regardless of where you get the research, it must be accurate and you must be honest in + how you use it.
    • +
+ + \ No newline at end of file diff --git a/DITA-CH9.xml b/DITA-CH9.xml new file mode 100644 index 0000000..afe38d1 --- /dev/null +++ b/DITA-CH9.xml @@ -0,0 +1,34 @@ + + + + + + + Cathie Ryan + Chapter 9: Emphasizing Important Information + Summary from Technical Communication by Mike Markel. + +

This chapter taught us about how to write so that important information is easily accessible + and understood. Here are some important points:

+
    +
  • Make sure that the titles and headings are informative. The titles and headings should + describe the section, and be indented id a way to highlight relative importance of the + information.
    • +
  • Separate out the important information into a list. The list can have the important phases + bolded and can have explanatory sentences following the bolded phrases.
    • +
  • Structure paragraphs so that the important information comes first. Then, any supporting + sentences can follow.
    • +
  • Divide paragraphs into manageable chunks. Find logical places to break paragraphs into + fewer sentences so that there is not so much information for the reader to understand or + remember.
    • +
  • Use transitional word and phases to convey meaning. Transitional words show relationships + and include words like also, likewise, although, above, and finally among many other words + listed on page 209.
    • +
+ + \ No newline at end of file diff --git a/concept-example.xml b/concept-example.xml index 6655f54..7cf8ad5 100644 --- a/concept-example.xml +++ b/concept-example.xml @@ -9,12 +9,14 @@ 'dtd1.2/technicalContent/dtd/concept.dtd'> - Your name - My Abstract - My Abstract + Cathie Ryan + JavaScript + Programming language that turns your webpages into a program. -

First paragraph

-

Second paragraph

-

One word

+

JavaScript is a programming language that you use with your webpages to turn webpages into a + program. It allows the developer to gather input and manipulate the webpage after the webpage + has been loaded.

+

Javascript is deeply embedded with the browser. It uses an event driven model which means + that the event is not run until the event is triggered.

 \ No newline at end of file diff --git a/reference-example.xml b/reference-example.xml index cd7bbaa..ade9870 100644 --- a/reference-example.xml +++ b/reference-example.xml @@ -6,26 +6,22 @@ - Other error messages - In addition to error messages generated by the DITA Open Toolkit, you might also encounter error messages - generated by Java or other tools. + JavaScript Events + Triggers the execution of the event that affect the webpage.
Out of Memory error

In some cases, you might receive a message stating the build has failed due to an Out of Memory error. Try the following approaches to resolve the problem:

    -
  1. Increase the memory available to Java.
    2. -
  2. Reduce memory consumption by setting the option to - false. This option is set in the lib/configuration.properties file. - This will disable debug attribute generation (used to trace DITA-OT error messages back to source files) and - will reduce memory consumption.
    3. -
  3. Set dita.preprocess.reloadstylesheet Ant property to true. This will allow - the XSLT processor to release memory when converting multiple files.
    4. -
  4. Run the transformation again.
    5. +
  5. Loading the webpage.
    6. +
  6. Leaving the webpage.
    7. +
  7. Clicking a link.
    8. +
  8. Scrolling up or down.
+ Specific JavaScript Error List java.io.IOException: Can't store Document

After running a JavaHelp transformation, you may receive a java.io.IOException: Can't store Document message.

diff --git a/task-example.xml b/task-example.xml index cb42bf3..710052f 100644 --- a/task-example.xml +++ b/task-example.xml @@ -8,33 +8,33 @@ - Changing the oil in your car - Once every 6000 kilometers or three months, change the oil in -your car. + JavaScript and Chrome Development Tools + Viewing the Chrone Development console. -

Changing the oil regularly -will help keep the engine in good condition.

+

Use the Chrome Development console to debug errors that can occur when JavaScript is run.

- To change the oil: + To view the console: - Remove the old oil filter. + Open the Developer Tools and click the Console Tab. - Drain the old oil. + At the > prompt, enter the JavaScript code to be evaluated. - Install a new oil filter and gasket. + If the JavaScript code evaluates correctly, you can enter this code into your + script. - Add new oil to the engine. + If the JavaScript code does not evaluate correctly, determine what is causing the + error. The error could be caused by a typo or misuse of a command. - Check the air filter and replace or clean it. + Once you have determined the cause of the error, return to step 2. - Top up the windshield washer fluid. + Continue to debug all errors until there are not any left to debug. From db3cec2ef3dd038cb18fb357a55b11b02f4483f8 Mon Sep 17 00:00:00 2001 From: Cathie Date: Thu, 6 Apr 2017 17:32:41 -0400 Subject: [PATCH 3/5] test change --- task-example.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/task-example.xml b/task-example.xml index 710052f..45de8bc 100644 --- a/task-example.xml +++ b/task-example.xml @@ -9,7 +9,7 @@ *--> JavaScript and Chrome Development Tools - Viewing the Chrone Development console. + Viewing the Chrone Development console. test

Use the Chrome Development console to debug errors that can occur when JavaScript is run.

From cfd326933759d747ef8a2eca9ecce50ee775b638 Mon Sep 17 00:00:00 2001 From: Cathie Date: Thu, 6 Apr 2017 17:34:22 -0400 Subject: [PATCH 4/5] more tests --- concept-example.xml | 2 +- reference-example.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/concept-example.xml b/concept-example.xml index 7cf8ad5..8b9e726 100644 --- a/concept-example.xml +++ b/concept-example.xml @@ -11,7 +11,7 @@ Cathie Ryan JavaScript - Programming language that turns your webpages into a program. + Programming language that turns your webpages into a program. test

JavaScript is a programming language that you use with your webpages to turn webpages into a program. It allows the developer to gather input and manipulate the webpage after the webpage diff --git a/reference-example.xml b/reference-example.xml index ade9870..04d02f8 100644 --- a/reference-example.xml +++ b/reference-example.xml @@ -7,7 +7,7 @@ JavaScript Events - Triggers the execution of the event that affect the webpage. + Triggers the execution of the event that affect the webpage. test

Out of Memory error From 62bcddfc16ba14f6daf6d037de39ffcbb04afcf3 Mon Sep 17 00:00:00 2001 From: Cathie Date: Thu, 6 Apr 2017 19:36:00 -0400 Subject: [PATCH 5/5] Create Dita map file --- DITA_MAP | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 DITA_MAP diff --git a/DITA_MAP b/DITA_MAP new file mode 100644 index 0000000..a07b6df --- /dev/null +++ b/DITA_MAP @@ -0,0 +1,8 @@ + + + + + + + +