Velasquez. Las Meninas (1656)


Course Information

Calendar view
Class notes
Course objectives
Textbooks
Grading plan
Policies
FrameMaker resources

Gradebook

Chatroom
Open forum
Project login

Class e-mail: send | archive
Quick survey: fill out | view



Weekly Schedule

Sept. 25
Oct. 2
Oct. 9
Oct. 16
Oct. 23
Oct. 30
Nov. 6
Nov. 13
Nov. 20
Nov. 27
Dec. 4
Dec.11

Other Links

ACC home page
BTCM Program home page

Course Overview

As you can see, this course is not quite ready yet. Check back May 26. This course used to be called Technical Publishing with Adobe FrameMaker. The name was changed to include Marcap Flare.

FrameMaker job postings at indeed.com. Sign up to get email updates for the latest Adobe Framemaker jobs in Austin, TX.
MadCap Flare job postings at indeed.com. Sign up to get email updates for the latest MadCap Flare jobs in Austin, TX.

Can I Run MadCap Flare on a Mac? Oh, Yes!. From MadCap.

This course begins with a general focus on Adobe FrameMaker or MadCap Flare in which you learn basic and book-building skills, along with some formatting and writing exercises. You'll study tutorials and then send me files that demonstrate you have understood the FrameMaker or Flare tasks in the tutorials. There will be several projects in this course in which you format existing text and graphics or write original documents. The final project involves a brief "book" that has all the formatting and automation elements we have studied during the course.

We will use a free license for FrameMaker 15 made available by Adobe or a free license made available by MadCap. These licenses have an extended expiration date; they will expire sometime in November 2017. You can install two—and only twice. Adobe or MadCap will terminate all licenses if anybody goes over this limit.

This course will feature new video tutorial recordings for FrameMaker 15 and Flare 11. The Janet Underwood book will apply in most cases to FrameMaker 15. The web-page tutorials are for FrameMaker 9, but little has changed for the basic functions they document. (Anybody want to update them for course credit?)

Semester/year Fall 2017
Instructor David A. McMurrey
Class meetings None: online-only class
Office Northridge 4225
Office hours Thurs. 10:00-3:00, and by apptmt. (Always call before driving all the way out to Northridge Campus.)
Phone 512-223-4804
E-mail davidm@austincc.edu

Week of September 25

Getting organized. In the first week of this course, let's get oriented and organized.

Go to course startup, fill out the questionnaire, tell us about yourself, and read about the course, objectives, policies, and grades — due Oct. 1

FrameMaker and Flare basics. Use the FrameMaker or Flare basics tutorial to get familiarized with basic tasks such as creating and saving files, making text italics or bold, changing fonts, changing tabs and margins, applying standard tags (such as for headings or numbered lists).

Go to FrameMaker and Flare basics practice, do the practice work, and send it to your instructor. — due Oct. 1

Note: If your version is not FrameMaker 15, save your FrameMaker file as a MIF file and send that.

Items of interest:

Week of October 2

FrameMaker and Flare tables. In this unit, use the FrameMaker and Flare table tutorials to learn how how to create tables in FrameMaker. (You'll need to use tables when you do the book-design project in one of the next units.)

Go to tables, do the practice work, and send it to your instructor, due Oct. 8

Tags and styles. Learn how to apply tags and how to modify them as necessary. The methods are different in FrameMaker and Flare, but the results and advantages are the same.

Go to FrameMaker tags (styles), do the practice work, and send it to your instructor, due Oct. 8
or
Go to Flare styles, do the practice work, and send it to your instructor, due Oct. 8

FrameMaker and Flare imitation project. In this project, you use existing FrameMaker tags or Flare styles to format text so that it looks exactly like a PDF document (or very close).

Styles/tags project: do this project, and send it to your instructor, due Oct. 8

Changing FrameMaker frame dimensions. You'll need this to do the styles and the tags projects.

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 1 (writing mechanics): ReadMe 1 Quiz — due Oct. 8
ReadMe 2 (constructing text): ReadMe 2 Quiz— due Oct. 8

Week of October 9

Master pages. Learn the difference between master pages in FrameMaker and Flare.

Go to FrameMaker master pages, do the practice work, and send it to your instructor, due Oct. 15
or
Go to Flare master pages, do the practice work, and send it to your instructor, due Oct. 15

Page layouts in Flare. Review how to use, create, modify, and apply Flare page layouts.

Go to Flare page layouts, do the practice work, and send it to your instructor, due Oct. 15

Templates in FrameMaker and Flare. Review how to apply templates, and learn how to create your own.

Go to templates, do the practice work, and send it to your instructor, due Oct. 15

Chapter-formatting project. Use graphics and unformatted text supplied by your instructor, create a well-designed technical document using FrameMaker or Flare and the tags that you have specified.

Go to the chapter-formatting project, do this project, and send it to your instructor, due Oct. 15

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 3 (writing style): ReadMe 3 Quiz — due Oct. 15
ReadMe 12 (illustrations): ReadMe 12 Quiz — due Oct. 15

Brief procedure project 1. Get started on the brief procedure in which in at least two FrameMaker pages you provide some instructions. Be sure to apply the guidelines on writing style, headings, lists, notices, and highlighting that you have studied previously.

Brief procedure documentation project 1 — due Oct. 22

Week of October 16

Brief procedure project 1. Don't forget—this thing is due this week.

Brief procedure documentation project 1 — due Oct. 22

Anchored frames & graphics with FrameMaker and Flare. Learn how to create and incorporate graphics into FrameMaker documents (with anchored frames) as well as how to use screen captures as well as create simple drawings in FrameMaker.

Go to frames and graphics, do this practice, and send it to your instructor, due Oct. 18

Basic page design. Study some of the standard specifications for headings, lists, notices, cross-references, tables, highlighting, simple typography and layout issues, and other. Explore what is common or standard, focusing particularly on page design concepts for written instructions and rhetorical strategies for writing effective instructions.

McMurrey. Page design
Page design quiz — due Oct. 18

Procedure-writing review. To get ready to write a good instructional procedure, read the link below. This is a collection of topics you may not have encountered before. But getting writing style, headings, numbered and bulleted lists, highlighting, graphics, and tables standard is critical inthe brief procedure projects.

McMurrey. Procedure-writing review

Week of October 23

FrameMaker and Flare file extensions. By default, Windows does not display file extensions. To display them for a folder, click Organize > Folder and search options > View, and then uncheck Hide extensions of known file types.

File extensions (opens in a popup window)

Autonumbering and variables with FrameMaker and Flare. Learn how to automate any numbering stream in a book, how to enable diiferent versions of the same documents using conditional text, and how to create variables for rapid updating.

Go to autonumbering, do this practice, and send it to your instructor, due Oct. 26

Simple book building and TOCs with FrameMaker. Learn how to build a book and generate, format, and update automated tables of contents.

Go to simple book building, do this practice, and send it to your instructor, due Oct. 26

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 10 (document types): ReadMe 10 Quiz — due Oct. 29

Week of October 30

Cross-references with FrameMaker or Flare. Learn how to create various styles of cross-references—both within the same document and between documents.

Go to Cross-references, do this practice, and send it to your instructor, due Nov. 1

Reference pages with FrameMaker. Learn how to use FrameMaker reference pages to store frequently used graphics that must be positioned consistently throughout a document, to hold boilerplate material or clip art that you can copy and paste on body pages (for example, symbols for cautions and notes), and to maintain hypertext commands, formatting information for generated lists and indexes, definitions of custom math elements, and mappings for converting to XML and HTML.

FrameMaker reference-page tutorial for FrameMaker 9.
For the FrameMaker reference-page practice, please send in the work you do in the tutorial — due Nov. 1

Book-formatting project. Your project will be to build a book—complete with automated page numbers, cross-references, tables of contents, indexes, headers, and footers—from text supplied by the instructor.

Book-formatting project — due Nov. 12

Readings in documentation. Please read these chapters before you start planning your project.

ReadMe 14 (GUI): ReadMe 14 Quiz — due Nov. 12

Week of November 6

Visit a forum. Post a question or search for an answer in a FrameMaker or Flare forum.

Watch the FrameMaker forum overview. As this video requests (password ACCstudent), research a question that has been already asked, and send e-mail to the Open Forum explaining what you asked and what you found out.

Flare forum visit — due Nov. 8

Book-formatting project. Don't forget—this thing is due this week.

Book-formatting project — due Nov. 19

Final project startup. Find some computer hardware or software product to develop a user guide for. Use the same ideas for project possibilities listed in the brief procedure project.

Project ideas
First draft — due Dec. 10
Final draft — due Dec. 17

Week of November 13

Indexing with FrameMaker or Flare. Read about standard process and guidelines for indexing hardcopy books, and then learn how to create indexes using FrameMaker.

Go to Indexing, do this practice, and send it to your instructor, due Nov. 15

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 18 (indexing): ReadMe 18 Quiz — due Nov. 15
McMurrey. Indexing
Indexing quiz — due Nov. 15
ReadMe 17 (glossaries): ReadMe 17 Quiz — due Nov. 15

Week of November 20

Final project—continued. Keep working on your final project.

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 8 (international): ReadMe 8 Quiz — due Nov. 22
ReadMe 9 (legal): ReadMe 9 Quiz — due Nov. 22

Week of November 27

First draft. Turn in the first, or "preliminary" draft of your final project. I'll turn it back around to you with comments as fast as I can.

First draft — due Dec. 10

Readings in documentation. Read about theory, process, and format related to documentation.

ReadMe 11 (editors): ReadMe 11 Quiz — due Dec. 3
ReadMe A (publications): ReadMe A Quiz — due Dec. 3

Week of December 4

Final draft. Using my comments, complete the final draft of your project and send it in.

Final draft — due Dec. 17

Week of December 11

Final draft. Using my comments, complete the final draft of your project and send it in.

Final draft — due Dec. 17


Information and programs provided by davidm@austincc.edu.