Technical Writing | AI-Assisted Documentation
Technical Writing | AI-Assisted Documentation
A five-page Canva Quick-Start Guide demonstrating technical writing, software documentation, and AI-assisted content development.
Developed a five-page Canva Quick-Start Guide using AI-assisted drafting, followed by hands-on testing, accuracy checks, and content revisions. Reviewed instructions, screenshots, terminology, and readability to create clear, accessible, and practical technical documentation for new users.
New employees may need to create branded presentations without prior experience using Canva. Unfamiliar editing tools, formatting options, and sharing settings can make the process confusing. The challenge was to develop concise, visually supported instructions that employees could follow independently.
Five-page illustrated quick-start guide
AI-assisted drafting and editing
Step-by-step Canva procedures
Screenshots of actual software controls
Hands-on testing and accuracy verification
Consistent terminology and formatting
Accessibility and readability review
Technical Documentation Brief
Audience
Deliverable
Role
Tools
Length
Project
Company
New employees with limited Canva experience
Five-page illustrated PDF quick-start guide
Technical Writer & Documentation Developer
ChatGPT • Canva • Google Drive
5 pages
Independent portfolio project
Cedar & Stone Consulting (fictional)
My Role in the AI-Assisted Process
I used ChatGPT to help plan, organize, and draft a five-page Canva Quick-Start Guide. I then tested the instructions directly in Canva, identified inaccuracies, and revised the content based on my findings. I also reviewed the document for clarity, consistency, and readability. Throughout the process, I made the final decisions about content, design, and usability.
Developed a five-page illustrated quick-start guide for employees unfamiliar with Canva.
Used AI to accelerate planning, drafting, and documentation development.
Identified and corrected inaccurate instructions through hands-on software testing.
Created a reusable reference document with screenshots, brand standards, and step-by-step procedures.
Demonstrated a human-verified workflow for producing technical documentation.
I included screenshots of Canva's interface alongside written instructions to help new users locate tools and complete unfamiliar tasks. Each screenshot was selected to support a specific procedure, reducing the need for users to search through the interface.
I tested AI-generated instructions directly in Canva and identified steps that didn't match the actual interface. I also discovered that certain formatting changes affected multiple elements unexpectedly. I revised the instructions based on my findings and added guidance to help users avoid these issues.
I created a brand reference with approved colors and fonts to ensure consistency. I paired clear instructions with Canva screenshots to help users locate formatting tools. Testing also revealed potential text wrapping and alignment issues, so I included guidance to help users avoid them.
This project strengthened my understanding of how AI can support technical documentation without replacing human judgment. AI helped me organize information and develop initial instructions, but hands-on testing revealed inaccuracies and usability issues that required revision. I learned the importance of verifying procedures, maintaining consistent formatting, and designing documentation for users with limited technical experience. In future projects, I would incorporate accessibility testing earlier and gather feedback from first-time users to further improve clarity and usability.