ENGL 3120    ※   Digital Writing & Publishing   ※    George Pullman






Assignments

This class is front-end loaded. Most of the assignments happen in the first nine weeks, but 40% of the final grade is determined by what you accomplish between Week 9 and week 15, your final portfolio, your HELLO WORLD moment. You need to get started right away and stay focused. You can't do all this in the last week of class. I will start grading each week's work Saturday morning. There are 28 students in this class, so it may take me to Monday to finish.

In what follows, when I offer examples, I use technical writing as the context because I am a rhetoric prof, this class is in the Rhetcomp division of English, and the most practical application of Rhetcomp is technical writing. Regardless of what field you are pursuing, you should create your own AI-assisted information. My examples are just examples no matter how relevant they might be to you.

It is a good idea to read each week's assignment before you do anything else. Just read. Don't click. Just read. Then start doing. You might want to keep a todo list for each week. Weeks 5, 6, 7 and 8 will likely require the greatest discipline and concentration. But week 9 gives you a chance to catch up and then if worse comes to worse, you sill have spring break to fix whatever is broken. DON'T PUT ANYTHING OFF. Seriously, you will hate yourself (and me).

Week 04 - AI Portfolio Reconnaissance DUE 5 pm, 02/02

A dad-joke illustration of the writer's burden

This week continues what you started last week. Use AIs to learn more about what you should put into your portfolio. I asked ChatGPT, for example, "Can you tell me what a technical writer's portfolio might look like?". I got the following:

Certainly! A technical writer's portfolio typically showcases their skills and expertise in creating technical documentation. While the specific content and format of a portfolio can vary, here are some common elements you might find in a technical writer's portfolio:

  1. Resume or About Me: An introduction that includes the writer's name, contact information, a brief summary of their background, and any relevant certifications or qualifications.
  2. Writing Samples: The core of a technical writer's portfolio is their writing samples. These may include:
    • User manuals: Examples of user guides, instruction manuals, or product documentation they've created.
    • API documentation: Samples of documentation for software APIs or developer documentation.
    • Tutorials: How-to guides or tutorials that explain complex processes or tasks.
    • Whitepapers: Longer, in-depth documents that explore technical topics or solutions.
    • Online Help: Screenshots or links to web-based help systems they've designed.
    • Release Notes: Examples of release notes for software updates.
  3. Case Studies: Real-world examples of projects the writer has worked on, including before-and-after examples that demonstrate how their documentation improved a product or process.
  4. Design and Layout: If the writer has experience with document design and layout, they might include samples of documents they've formatted to make them more user-friendly.
  5. Tools and Technologies: A list of software tools and technologies the writer is proficient in, such as Microsoft Word, Adobe FrameMaker, MadCap Flare, or any other relevant tools.
  6. Testimonials and Recommendations: Quotes or recommendations from colleagues, supervisors, or clients that speak to the writer's skills, work ethic, and professionalism.
  7. Blog Posts or Articles: If the writer maintains a blog or has written articles on technical writing topics, they might include links to these as well.
  8. Visuals and Graphics: Diagrams, illustrations, or graphics that they've created to enhance their documentation.
  9. Samples of Style Guides: If the writer has created or worked with style guides, they may include excerpts or examples from these guides.
  10. Contact Information: A way for potential employers or clients to get in touch, such as an email address or LinkedIn profile.

Remember that the portfolio should be well-organized, easy to navigate, and visually appealing. It should demonstrate the writer's ability to effectively communicate technical information and create documentation that serves its intended audience. The specific content and layout can vary based on the writer's personal style and the types of projects they've worked on.

Perhaps I should have asked for what an entry-level technical writer's portfolio might look like. Or maybe instead of "look like" I should have written "put into." Remember to be specific. Details, details, details.

I gave Google's Bard a similar but slightly different prompt: Can you give some ideas about what to put in a technical writing portfolio? [I varied the prompt because my goal isn't to compare AIs but to get as much input as I can. But I still said "put into", which is too vague, and I didn't specify entry level, which I should have.]

Essential Elements of a Technical Writing Portfolio

A technical writing portfolio is your chance to shine a spotlight on your skills and experience. It's not just a collection of writing samples; it's a curated showcase of your ability to translate complex information into clear, concise, and user-friendly content. Here are some essential elements to include:
  1. Introduction & Summary:
    Briefly introduce yourself and your technical writing background.
    Highlight your key skills and areas of expertise.
    Summarize the content of your portfolio and what you hope to achieve with it.
  2. Writing Samples:
    Choose 3-5 of your best writing samples that showcase your range and versatility.
    Include a mix of formats, such as user manuals, API documentation, online help articles, blog posts, or white papers.
    Briefly explain the project context, your role, and the specific challenges you addressed.
  3. Process & Methodology:
    Briefly outline your technical writing process.
    Mention the tools and technologies you use, like content management systems or authoring tools.
    Highlight your approach to research, collaboration, and revision.
  4. Testimonials & Recommendations:
    Include quotes or letters of recommendation from satisfied clients or colleagues.
    This adds social proof and credibility to your portfolio.
  5. Contact Information:
    Make it easy for potential employers to reach you.
    Include your email address, website, and LinkedIn profile.

By following these tips, you can create a technical writing portfolio that will impress potential employers and land you your dream job.

I hope this gives you a good starting point for creating your own technical writing portfolio!

It also gave me the following link: Everything Technical Writing

You should run your own prompts even if you are planning to become a technical writer. Mine are imprecise.

I asked MS's Copilot a much more general question: "What are the five most important things to have in an entry level job-seeking portfolio?"

Here is it's response:

Career Summary

A short paragraph that describes your relevant work experience, skills, and professional accomplishments.

Mission Statement

A statement explaining your professional beliefs and expresses what you want to be, do, and have in your career.

Brief Biography

A section that allows you to showcase more of your personality and connect on a more personal level with employers.

Resume

A document that summarizes your education, work experience, and skills.

Cover Letter

A letter that introduces yourself and explains why you're interested in the position.

References

A list of people who can vouch for your skills and experience.

Certificates and Licenses

Documents that prove your qualifications.

Transcripts

Official records of your academic achievements.

Work Samples

Examples of your work that demonstrate your skills and experience.

Testimonials

Statements from previous employers or clients that attest to your skills and experience.

Awards and Recognition

Certificates or other documents that recognize your achievements.

Professional Development

A list of courses, workshops, or other training programs that you've completed.

Remember, the most important thing is to tailor your portfolio to the specific job you're applying for. Make sure that the materials you include are relevant to the position and demonstrate your qualifications for the job.

Not bad general advice, but general is all it is. You might ask follow-up questions like, You've advised me to write a cover letter. Given that I am looking for an entry level job in X profession, what should I put in my cover letter? Also, please give me an example. You might follow that up by giving it your details and asking it to write a letter for you. If you give it really good, detailed, specific, information, you might get a solid draft. Just make sure you don't post anything AI-sounding.

You can also ask for advice about how to write a resume.

Blog about the prompts you used. Copy and paste (formatted) or upload screen caps of what the prompts returned. And then write a few paragraphs about what you learned and what you plan to do next.

GRADE: 10%