Tools and Technologies for Technical Writers. Release

Tools and Technologies for Technical Writers Release Nov 28, 2016 Contents 1 Getting Started 3 2 Markup Languages 13 3 Publishing Systems ...
Author: Camron Walsh
4 downloads 1 Views 231KB Size
Tools and Technologies for Technical Writers Release

Nov 28, 2016

Contents

1

Getting Started

3

2

Markup Languages

13

3

Publishing Systems

23

4

Wrap Up

27

i

ii

Tools and Technologies for Technical Writers, Release

Middlesex Community College This course will help you become familiar with a wide variety of current tools and technologies writers use to publish online content.

Contents

1

Tools and Technologies for Technical Writers, Release

2

Contents

CHAPTER 1

Getting Started

To get started, we will set up our content management system and an editor. And we’ll learn about HTML, which is the format in which we’ll deliver all information.

1.1 Introduction 1.1.1 Goals This course will help you become familiar with a wide variety of current tools and technologies writers use to publish online content. This course will not make anyone an expert in any tool. Rather, we aim to: • Help you learn basic skills in a variety of tools. • Provide context for tool choices. • And most importantly, help you learn how to learn. Undoubtedly, in five years you will not be using the same tools that we use in this class. You will need to adapt to rapid change. We will stress using all available sources, and hands-on use, to learn new tools. At the end of the course, you should have: • A broad understanding of multiple technologies. • The ability to create basic content with different tools. • The inclination to ask the right questions and find the answers when learning about a new technical subject.

1.1.2 A “Flip” Classroom Traditional classes involve a teacher talking and demonstrating during class time, and students completing assignments outside of class. This class “flips” that model. Students are expected to read and view all material for the class, and work on assignments, before coming to the classroom. We will use class time to: • Ask and answer questions. • Do hands on work, individually and in teams. • Share work in an open, supportive atmosphere. I do not intend to lecture during class. 3

Tools and Technologies for Technical Writers, Release

1.1.3 GitHub We will use GitHub to communicate and to exchange files. Many of you will use GitHub or a similar system in your future jobs, so this is a good opportunity to learn more about it.To get started, create an GitHub account. Then add your GitHub user name to the discussion so the rest of the class can collaborate with you. We will discuss GitHub in the 1st class. Do the reading before then.

1.1.4 Editors For most assignments, we will use Sublime to edit files. We will discuss Sublime in the 1st class. Do the reading before then. Later in the semester we will install trial versions of FrameMaker and Madcap Flare. Caution: Do not install these programs until we are near those classes; otherwise, your trial period might end before you can complete the assignments.

1.1.5 Expectations You must bring curiosity and enthusiasm for hands on work. You must do the reading and watch videos before class, so we can use class time for discussion and hands-on learning. If you get stuck, search for answers first, then ask on our class page. I’ve selected what I think are good articles and videos for this class. But there are many more. You are encouraged to search on your own, and if you learn a trick we haven’t covered, share it. You will need to spend 10 - 15 hours per week for this class. Class participation online, between class meetings, is expected. You are also expected to collaborate, in small teams and as a class. There will be team projects – after all, that is how most of you will work. I will comment on your work. You are encouraged to help each other and comment on each other’s work as well. You should be familiar and comfortable with either a Mac or Windows, and web browsing.

1.1.6 Class Discussions Active class participation, both in our weekly meetings and online, is a must. We will use the page of this syllabus to discuss questions online. GitHub issues function much like a discussion board. You can start a new issue, and comment on existing issues. Issues are Open or Closed. I’ll close an issue when the question has been answered. But you can still get good information by browsing Closed issues. Everyone is encouraged to ask questions, and comment on others’ questions. To get started, please go to the GitHub - Issues page, find the Introductions issue, and add a comment to introduce yourself.

4

Chapter 1. Getting Started

Tools and Technologies for Technical Writers, Release

1.1.7 Assignments This course is pass/fail. No grades are submitted (unless one is necessary for tuition reimbursement). There are short assignments for each technology we cover in class. These assignments are intended to provide a taste of working with different technologies. Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. I will comment extensively on your work and answer questions. I also expect you to help your peers. If you see a question in , don’t wait for me. Try to offer good suggestions. There is also a Final Project due at the end of the term. The project will allow you to work more deeply with a chosen technology.

1.1.8 An Open Source Course To align with industry trends, we will use several open source technologies in this class. Writers should be aware of these options. The days of buying expensive software from large vendors, then being locked into that system, are over. In addition, we’re not just learning about the open source world, we are experiencing it. How? Let’s look at the ways: • Much of the content of this course comes from freely available sources, such as Wikipedia, YouTube, and SlideShare. My role is to assemble sources into a coherent story that meets our objectives. • Content on Wikipedia and YouTube, two of our primary sources, is created by users, not owners. That is, these platforms derive their value from the aggregated efforts of the community, just as do the open source projects we will discuss. • This syllabus is created, stored, and hosted using only open source tools. This didn’t cost a cent, and just about any aspect of it can be modified. • In fact, this syllabus is open source, with a Creative Commons license. You can, and are encouraged to, make it better and to share it, using the tools we will learn about.

1.2 Final Project You will complete a final project for this course. The project is to produce a substantial document through one of the tools we examine over the semester. I recommend doing the project in one of the markup Languages we work with in the first half of the course, for several reasons: • You will have more time to apply what we learn. I expect that you will put substantial time into the project, and if you wait to use tools we cover near the end of the term, you will need to rush. • Tools for using the markup languages we cover are free. You will not have to worry about licenses and trial periods. • You will be able to use GitHub to manage your project, which will make it easy for me (and other students) to provide feedback, and for you to iterate through revisions using the GitHub Flow. • Finally, I believe that the direct use of markup languages is a growing requirement for technical writers, and doing a substantial project that you can share and continue to enhance will help you in a job search. 1.2. Final Project

5

Tools and Technologies for Technical Writers, Release

1.2.1 Partners While you will complete your own project, you will have a partner. The partner’s role is to provide feedback and help. You are free to share your work in progress with others in the class, but you must have at least one designated partner. In addition, being a partner to another student will help you see project development from a different angle. You might think of things when looking at your partner’s project that you would not see in your own work. Finally, having a partner, or “peer editor” is something you’ll have to do as a professional technical writer.

1.2.2 Proposals By class 9, please add your proposal to . I will comment on proposals as needed. I encourage you to view others’ proposals and share constructive ideas.

1.3 GitHub GitHub is a free online service that we will use to manage content. More and more companies are using GitHub, or similar services, today. We will use GitHub for most of the exercises in this course, so it is critical to go through all the readings and videos in this lesson.

1.3.1 Goals • Become comfortable completing basic tasks with GitHub. • Understand how GitHub fits in a common workflow. • Create your account in GitHub.

1.3.2 Readings • • • •

6

Chapter 1. Getting Started

Tools and Technologies for Technical Writers, Release

1.3.3 Videos Get Started with GitHub GitHub Flow GitHub Desktop

1.3.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. . 2. Follow steps in . 3. . In addition, go to and introduce yourself and add your GitHub username in the appropriate threads.

1.4 Sublime We will use Sublime when working with markup languages. Sublime lets you edit plain text, and includes many packages that help with specific languages. Through there are various tools to make work easier, working in plain text will give you a better understanding of the subjects we will cover. You can choose to use other plain text tools, such as Atom, Notepad, or Visual Studio Code.

1.4.1 Goals • Get Sublime set up as your editor. • Make content changes using Sublime.

1.4.2 Readings • •

1.4.3 Videos Install Sublime Learn Sublime

Note: In the upper left of the video, you’ll see a playlist icon. This indicates the video is part of a series. Click the icon to open the list of videos in the series. View each one.

1.4. Sublime

7

Tools and Technologies for Technical Writers, Release

1.4.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. Install Sublime. 2. Install . 3. Go through the GitHub flow using the desktop application and update your Hello World repository in any way you want. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

1.5 HTML Most of the content we deliver on line is in HTML. In later lessons, we will use a variety of tools that make creating HTML easier. Although these tools help us avoid the verbosity of HTML, it is very helpful to know HTMl basics, which is why we start the course working directly with HTML.

1.5.1 Goals • Understand the purpose and history of HTML 5. • Become comfortable editing HTML 5. • Learn to create a fork of a repository and make changes to your copy. • Publish your own web page.

1.5.2 Readings • •

1.5.3 Videos 1.5.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

8

Chapter 1. Getting Started

Tools and Technologies for Technical Writers, Release

Follow the GitHub flow to complete this assignment. After you fork the repository, you can complete the assignment through the browser, or through GitHub Desktop and Atom (or another text editor). 1. Make a fork of in your own GitHub account. 2. Create a new branch to edit your repository. 3. In your new repository, edit the index.html file. 4. Give the page a title. 5. In the two article elements, add something about yourself, with a title and description. 6. In the first aside, add a picture and description. 7. In the second aside, add your favorite quotation. 8. Add an id attribute to each article element. 9. In the nav element, change the text of the link to match the article titles, and add links to each ID. For information on adding links to IDs, see . 10. Save the file, then open it in a browser and check it out. 11. Edit the file as needed, then view again. Keep repeating until you are satisfied. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

1.5.5 View Your Work You now have a web page that you, and your friends and family, can view. 1. In the repository, open the Settings tab. 2. Find the GitHub Pages section. 3. For the Source, select master branch. 4. Click Save. The URL of your new website is now listed. Open it. If you don’t like something in your web page, edit the index.html file again.

1.5.6 Extra Credit Recommended if you intend to do your final project in HTML.

1.6 CSS Most HTML content is formatted and styled with CSS code. CSS is most heavily used by web designers. However, because CSS has such a high impact on how users experience content, it is essential for writers to have a basic understand of how it works.

1.6. CSS

9

Tools and Technologies for Technical Writers, Release

1.6.1 Goals • Gain a basic understanding of CSS. • Modify the look and style of your web page with CSS.

1.6.2 Readings • • • Note: If you prefer to use a different browser, there are equivalent tools.

1.6.3 Videos Note: In the upper left of the video, you’ll see a playlist icon. This indicates the video is part of a series. Click the icon to open the list of videos in the series. View each one.

1.6.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. Find a partner for this assignment. You should work together, though you only need to complete these steps for one repository. Follow the GitHub flow to complete this assignment. You can complete the assignment through the browser, or through GitHub Desktop and Atom (or another text editor). Note: The goal of this exercise is to learn the mechanics of editing styles in a web page. It is not a design contest. 1. Create a new branch in your Get Started HMTL repo. 2. In your new branch, edit the styles.css file. Hint: Use Chrome Inspector to experiment with changing styles. 3. For the nav element: • Apply a unique color. • Create a border around it. • Change the background color so it sticks out on the page. 4. For the article element: • Create a border around the article.

10

Chapter 1. Getting Started

Tools and Technologies for Technical Writers, Release

• Change the style of the header however you see fit. • Indent the p element. • Change the background color so it sticks out on the page. 5. For the aside element: • Move the aside element so that it appears next to article, aligned on the right side. • Make the h2 smaller than the h2 for article. • Change the style of the header however you see fit. • Indent the p element. • Change the background color so it sticks out on the page. 6. Make the footer smaller. 7. Continue editing the styles and refreshing the web page until you are satisfied. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

1.6.5 Extra Credit Recommended if you intend to do your final project in HTML.

1.6. CSS

11

Tools and Technologies for Technical Writers, Release

12

Chapter 1. Getting Started

CHAPTER 2

Markup Languages

Now that we’ve learned some HTML, it should be apparent that writing large volumes of content directly in HTML would not be efficient. There are several markup languages that we can use to produce HTML more easily. We’ll look at some of the most common.

2.1 RST (reStructuredText) 2.1.1 Goals • Learn the basic syntax of RST. • Edit a page in RST. • Learn to use Atom packages to improve the RST editing experience. • Be prepared to create documentation sets in Sphinx.

2.1.2 Readings • • •

2.1.3 Video 2.1.4 Practice Note: Indentation is important in RST. Lots of problems are caused by inconsistent indentation. The only way to learn is to practice and see the results.

2.1.5 RST and Atom • • 13

Tools and Technologies for Technical Writers, Release



2.1.6 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. Use to create a short version of your resume (or something else if your prefer). Share the link in . 2. Fork the . 3. Read all the files in the repository. 4. In your repository, use the templates to create a documentation set. Start with the topic.rst file. Use at least 2 levels of headings. Edit and rename files as needed. You should use at least: • 3 different pages. • One table, one numbered list, one unordered list. • One code block. • One external link. • One substitution. • Two different conditions. • One note and one caution. • One image. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master. These files will form the basis of your Sphinx project in the next lesson.

2.2 Sphinx Sphinx is a tool for compiling sets of RST files into an HTML document. (You can also use Sphinx to create many other document formats.) We will use Sphinx to publish the RST content we created in the previous class as HTML .

14

Chapter 2. Markup Languages

Tools and Technologies for Technical Writers, Release

2.2.1 Goals • To understand the role of Sphinx in building documentation. • To learn how to organize a Sphinx document and reuse content. • To build a documentation set with Sphinx.

2.2.2 Readings • •

2.2.3 Videos 2.2.4 Install Sphinx To build your HTML document on your computer, you must install Sphinx. 1. If you are using Windows, you might need to . Depending on your Windows setup, after installation you might need to manually add the Python directory to your path. Try the for help. If you are using a Mac, it’s probably installed. 2. . Depending on your Windows setup, after installation you might need to manually add the PIP directory to your path. 3. Use PIP to install Sphinx. On the command line, enter: $ pip install Sphinx

2.2.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. Part 1 1. Make a fork of in your own GitHub account. 2. Read the repository ReadMe. 3. Check out your repository on your computer. 4. Open a command prompt and change directories to the get_started_sphinx directory. 5. Run the command make html. Check if there are warnings or errors in the command window. There should not be. 6. Check for the HTML output in the get_started_sphinx/build/html directory.

2.2. Sphinx

15

Tools and Technologies for Technical Writers, Release

7. Open the file index.html. The page should look like the following image.

Make sure you complete these steps with no warnings or errors before proceeding. Part 2 Look back to the last class on RST (reStructuredText). Review the files in , and the files your created as part of that assignment. You can use the content of those files. Add them into the your fork of the repository, or copy the content into the files that are already part of the Sphinx project. The same requirements apply. When you have added content to RST files in the Sphinx project: 1. Run the command make html. Check if there are warnings or errors in the command window. Fix those issues. Use Google, or if you get stuck. 2. Check for the HTML output in the get_started_sphinx/build/html directory. 3. Open the file index.html. Check that the content is what you expect. 4. Iterate over these steps until the document is what you intended. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

2.2.6 Extra Credit • Change the Sphinx theme by changing the value of html_theme in the conf.py file. Search Sphinx documentation for more information. • Checkout the (the source for this syllabus). Examine how the document is organized. Create a branch and make an improvement in this syllabus. Build it locally and ensure it comes out as you expect. Then submit a pull request. Recommended if you intend to do your final project in Sphinx.

16

Chapter 2. Markup Languages

Tools and Technologies for Technical Writers, Release

2.3 Read the Docs Read the Docs is a free service that publishes and hosts documentation. In fact, this syllabus is published through Read the Docs. We will use Read the Docs to publish our Sphinx projects.

2.3.1 Goals • To understand where Read the Docs fits in our tool set. • To publish our Sphinx project through Read the Docs.

2.3.2 Readings • •

2.3.3 Videos 2.3.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. Create an account on . 2. Set up a project to publish the document in your GitHub repository. 3. Share the URL of your project in .

2.4 XML 2.4.1 Goals • Understand what XML is and its role in writing and publishing content. • Understand that XML brings semantic meaning to content.

2.4.2 Readings • •

2.3. Read the Docs

17

Tools and Technologies for Technical Writers, Release

2.4.3 Videos 2.4.4 Sublime for XML Install the following packages to make it easier to edit XML in Atom. • •

2.4.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. Create a new repository in Github. 2. Create a new branch. 3. Add an XMl file in the branch. Look at content you created in an earlier lesson. Think about how it can be organized by semantic meaning. Here are a few examples: 1 2 3 4 5 6 7 8 9

1 2 3 4 5 6 7

Your name The Title Two sentence abstract. First paragraph Second paragraph 3 M Joseph

4. Add data in the file. Use at least 4 elements and one attribute. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

18

Chapter 2. Markup Languages

Tools and Technologies for Technical Writers, Release

2.5 DITA Introduction 2.5.1 Goals • Understand the philosophy and goals of DITA. • Understand the basic DITA topic types.

2.5.2 Introduction 2.5.3 Readings • • • •

2.5.4 Videos Note: At the end of the video, you’ll see other videos in the series. Continue with the series.

2.5.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. In the repository you made in XML, create a new branch. 2. Modify the XML file you created to be a valid DITA topic. For this exercise, make the topic a concept. For example, you could modify the document from the preview lesson: 1 2 3 4 5 6 7 8 9

Your name The Title Two sentence abstract. First paragraph Second paragraph

Into a DITA concept. 1 2 3



2.5. DITA Introduction

19

Tools and Technologies for Technical Writers, Release

Your name My Abstract My Abstract First paragraph Second paragraph

4 5 6 7 8 9 10 11 12

Use valid elements for a concept. 3. Validate the file against the DTD for the topic type. Note: You must set the DOCTYPE declaration to the path and name of the DTD. Take a look at the sample files in the . Copy the dtd1.2 folder from there into your branch, and validate your file against the concpet, task, or When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

2.6 DITA 2.6.1 Goals • Deepen the understanding of DITA. • Understand DTDs and validation. • Use to learn how to work with tools designed for DITA.

2.6.2 Readings • (Read carefully) • • - Getting Started lessons

2.6.3 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

20

Chapter 2. Markup Languages

Tools and Technologies for Technical Writers, Release

Part 1 . Part 2 Repeat the assignment in DITA Introduction, only this time use XMLMind. Add a task and a reference topic to your pull request. Make sure to change the DTD declaration to point to the right DTD for the topic type. When your work is ready: 1. Save and commit your work to your branch. 2. Create a pull request for the branch. 3. Tag @MarkHoeber in the pull request. 4. After I give a thumbs up, merge the branch to master.

2.7 DITA Maps 2.7.1 Goals • Understand the purpose and use of DITA Maps. • Understand how DITA Maps enable reuse strategies. • Assemble topics created into a DITA Map.

2.7.2 Readings • •

2.7.3 DITA Maps and Reuse 2.7.4 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class. 1. this 2. this 3. this

2.7. DITA Maps

21

Tools and Technologies for Technical Writers, Release

22

Chapter 2. Markup Languages

CHAPTER 3

Publishing Systems

There are many more robust publishing systems that we can use to develop content with more fine-grained control. These programs offer more features and capabilities than markup languages, but also involve more complexity and overhead. We can still produce HTML, as well as some other formats.

3.1 FrameMaker Part 1 3.1.1 Goals • Create a FrameMaker document. • Learn how to format a document and manage styles. • Publish PDFs with FrameMaker.

3.1.2 Readings •

3.1.3 Extra Credit 3.1.4 Videos 3.1.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

3.2 FrameMaker Part 2 3.2.1 Goals • Learn about advanced capabilities of Frame, such as conditional text, variables, indexing, and cross references. • Assemble a book from several Frame documents. 23

Tools and Technologies for Technical Writers, Release

• Use FrameMaker to edit DITA content.

3.2.2 Readings •

3.2.3 Extra Credit 3.2.4 Videos 3.2.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

3.3 Flare Part 1 3.3.1 Goals • Create a Flare document. • Learn how to format a document and manage styles. • Publish HTML and PDFs with FrameMaker.

3.3.2 Readings •

3.3.3 Extra Credit 3.3.4 Videos 3.3.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

3.4 Flare Part 2 3.4.1 Goals • Reuse topics in Flare. • Modify HTML layout.

24

Chapter 3. Publishing Systems

Tools and Technologies for Technical Writers, Release

3.4.2 Readings •

3.4.3 Extra Credit 3.4.4 Videos 3.4.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

3.4. Flare Part 2

25

Tools and Technologies for Technical Writers, Release

26

Chapter 3. Publishing Systems

CHAPTER 4

Wrap Up

We will use the last two classes to work on and present our projects.

4.1 Choice and Projects 4.1.1 Goals • Cover any questions and explore other technologies as requested. • Work and collaboration on projects.

4.1.2 Readings •

4.1.3 Extra Credit 4.1.4 Videos 4.1.5 Assignment Do as much of this assignment as you can before class. If you get stuck, search for the answer with Google. Or use the GitHub Issues for the course to ask questions. You will have a chance to complete the assignment during class. Submit the assignment by the end of class, or if necessary, within a day after class.

4.2 Project Presentations 4.2.1 Goals • Share Projects

27