Skip to main content
All learning experiences

Technical Writing & Software Documentation

Software Partner Technical Guide — Professional Work

Technical Writing & Software Documentation · Developed while at InvoiceCloud

A long-form technical guide created in a professional SaaS environment to help software partners complete tasks and find answers within a complex billing and payment platform.

  • Microsoft 365

Project overview

A long-form technical guide created in a professional SaaS environment to help software partners complete tasks and find answers within a complex billing and payment platform. The project required task analysis, information architecture, procedural writing, screenshot planning, and translating technical functionality into clear, usable documentation.

The guide combines procedural writing with visual guidance so users understand both what a feature does and how to use it. It demonstrates my ability to learn complex software, organize substantial technical information, and turn it into practical documentation.

Audience

Software partners and their support staff working directly in the platform, alongside internal teams who assist them.

Learning need

Not every performance need requires a course. Technical documentation can provide durable, searchable support at the moment of need.

Partners work in the platform intermittently and across many different tasks, so the right solution was reference material they could return to rather than training they would have to remember.

Instructional design rationale

The guide is organized around common functions and the tasks partners perform within them, so someone can find the section that matches their situation instead of learning the system's internal organization first.

Each procedure pairs written steps with the interface it describes, which is what makes documentation usable at the moment of need rather than only during a read-through.

Performance support principle

Why this is performance support

This project reflects a core performance-improvement principle: training is not always the right intervention. Because users perform many tasks intermittently, durable and searchable documentation provides support when the task actually occurs. Task-based organization, procedural steps, and visual guidance reduce the need to remember information from a previous training event.

Professional work & confidentiality

The original guide was created as part of my professional work for a former employer and is not publicly distributed. To protect employer-owned materials and internal system information, this portfolio presents the design approach, documentation strategy, and skills demonstrated rather than pages from the original guide.

Portfolio sample

Sanitized writing sample

The original guide was created for a former employer and is not publicly distributed. The sample below is a portfolio adaptation that demonstrates the structure, tone, and procedural-writing approach used in the original work without reproducing employer-owned content or internal system details.

Export a transaction report

Use the reporting area to create a file containing the records you need.

  1. Open Reports.
  2. Select the date range you want to review.
  3. Choose any filters needed to narrow the results.
  4. Review the results before exporting.
  5. Select Export.
  6. Save the file to your computer.

Tip

If the report does not include the records you expected, check the date range and filters before running it again.

Troubleshooting an empty report

  1. Confirm that the selected date range includes the activity you need.
  2. Remove unnecessary filters.
  3. Run the report again.
  4. If results still do not appear, confirm that you have access to the records you are trying to view.

Writing approach

  • Task-based headings
  • Short procedural steps
  • Plain language
  • One action per step
  • Troubleshooting placed close to the task
  • Information organized for quick reference rather than continuous reading

Design decisions

Organized around common functions and partner tasks
Partners arrive with a job to do. Grouping procedures by function and the tasks performed within it helps them find the relevant answer quickly.
Visual guidance paired with each procedure
Written steps alone leave room for interpretation. Showing the interface being described removes it.
Technical depth kept where it belongs
More technical material sits in its own section so routine users are not slowed down by content they do not need.

What this project demonstrates

  • Technical writing and software documentation
  • Information organization at scale
  • Performance support as an alternative to training
  • Task analysis and information architecture
  • Translating complex software into understandable instructions

Related projects

Opening cover image from the Ethical and Inclusive AI in Online Course Design course, showing a glowing AI network on a tableteLearning / Articulate Rise 360

Articulate Rise 360 + Storyline 360

Ethical and Inclusive AI in Online Course Design

Graduate Instructional Design Project — University of Memphis

A longer, more scaffolded course on ethical and inclusive AI use in online teaching, built in Rise 360 with a custom Storyline 360 branching scenario embedded where decision practice was needed.

  • Articulate Rise 360
  • Articulate Storyline 360
Opening cover image from the Memphis public transportation course, showing two riders waiting at a MATA bus stopeLearning / Articulate Rise 360

Articulate Rise 360

Navigating Public Transportation in Memphis: A Guide for Riding MATA

Community Education — Friends For All

A streamlined Rise 360 course helping adult community learners build confidence using public transportation in Memphis, with interactions chosen to reduce cognitive load rather than to demonstrate complexity.

  • Articulate Rise 360
Opening cover image from the Smart Shopping courseeLearning / Articulate Rise 360

Articulate Rise 360

Smart Shopping: Practical Skills for Everyday Savings

Community Education — Friends For All

A Rise 360 course giving adult community learners low-risk practice recognizing and applying practical shopping strategies in everyday purchasing decisions.

  • Articulate Rise 360

Get in touch

Questions about this project?

I'm glad to walk through the analysis behind the decisions, or how I'd adapt this approach to your organization.