Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / writing / Now you can take the technical writing class but skip the tests

October 16, 2007 by annegentle

Now you can take the technical writing class but skip the tests

I just discovered the greatest course syllabus for a technical writing class, English 107, at Lehigh Carbon Community College in Schnecksville, PA. Makes me wish I was taking this class.

Course reading list (on a wiki, no less!)

Weeks nine and ten really have me excited. Because I’m a technical writing dork that way. Here’s a copy and paste.

—8<—

Week Nine: Web 2.0 and Education

  1. Watch Web 2.0
  2. Watch Tim O’Reilly’s Interview about Web 2.0
  3. Watch Web 2.0 and Language Learning by Graham Stanley
  4. Watch EdTrends
  5. Watch Feel Again
  6. Watch Greater IBM and Second Life
  7. Watch IBM Second Life Highlights

Assignments

  • Educators and businesses are using Web 2.0 and the 3D web to save money. What costs are saved by using 2.0/3D web technology? Write a memo and send it via WebCT.
  • Create a semi-formal report comparing and contrasting the uses of Web 2.0 OR Second Life in Education and Business. Explore the advantages and disadvantages. Your report should have:
    • A Title Page
    • Overview
    • Background
    • Methodology/Criteria for research
    • Research findings
    • Discussion
    • Conclusion
    • Works Cited

Week Ten: Web 2.0 and Technical Communication

  1. Read ” The Quick Web” for Technical Documentation by Anne Gentle
  2. Read Writing Becomes Industrial by Neil Perlin
  3. Read Complete Information Gets Used by Geoffrey JS Hart
  4. Read Top Ten Tips for Writing Online Surveys
  5. Read Managing conflicts within a Team of Writers
  6. Read Open Source for Tech Writing Teams
  7. Read Web 2.0 for Technical Communicators

Assignments
1. What is the role of the technical writer in business and industry? Send me an email detailing your ideas.
2. Create a web survey using Survey Monkey and ask everyone you know to complete the survey. Find out how they use technical writing in the workplace. Survey at least twenty people.
3. Create an analysis report of the data collected in the surveys and submit via WebCT.
—8<—
I’ve interviewed two graduate-degree earners, but neither of them would have looked at Web 2.0 in the way this class is headed.

I am setting aside some time to do the reading assignments myself. You may want to also. A highly successful director at BMC used to set aside two hours of reading time a week for articles like these (no emails, just uninterrupted reading time), and it showed in her forward thinking and leadership qualities.

Related

Filed Under: writing

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in