mollieswenson/cpp_course_files

Hi! Thanks for reviewing my portfolio. Below are my techical documentation projects.

Proprietary Game Engine

I created extensive documentation about the architecture, usage, and APIs for a proprietary game engine developed by a AAA video game studio. I was the sole writer for an audience of ~300 game developers, including server, game systems, graphics, and other engineering teams, as well as technical designers and content creators. I received professional recognition for my contributions to the project, and later also worked as a software engineer on the same game engine. Due to NDA, I am unable to share this documentation, but am happy to discuss it further upon request.

xPico200 SDK

This SDK guide teaches SDK users how to create, build, and deploy firmware to an embedded gateway device. Here's what's included:

• Overview of the SDK's modular/component-based architecture, and steps to create modules, build projects, and load firmaware.
• Detailed information about what is happening in the C-language code used in the sample applications.
• An automatically-generated developer reference that includes function documentation for all modules, including descriptions, parameters, data types, and return types. Additionally, the developer reference includes information about data structures and header files. This documentation is generated by Doxygen as as HTML output, and then manipulated using Python to prepare the HTML for inclusion in the SDK Guide files.
• Getting started content, with quick-start tutorials that let users build and deploy working firmware in just a few clicks.

FoodTruck API

This API documentation includes Node (JavaScript), Python, and cURL code samples for all GET, POST, PUT, and DELETE API operations, as well as information on authentication, errors, and an overview. It is written in Markdown and published using Slate.

I wrote the code for the FoodTruck API as part of a course on API development! It uses Node with Express and MongoDB. See the code on GitHub.

Video Search App

This React component wiki documents the React components used in a video search app, including property name, type, description, initial state, and state change functions. It's written in Markdown and published using GitHub Wiki.

I wrote this app as part of a course on React. It makes calls to the YouTube API and updates the search results as the user types. See the code on GitHub.

Therapist Bot App

This code documentation records the constants, functions, and enumerations used in the JavaScript code of this application. It's written in Markdown and published as the project readme.

I wrote this app for a course on code documentation. The app is a (mildly rude) therapist who is happy to discuss your problems for hours on end. A working demo therapy session and the code are on GitHub.

Soundboard App

I wrote this soundboard app so that my D&D group could have a cool soundboard when we get together. It uses JavaScript, jQuery, HTML, and CSS. The source is on GitHub.

More Projects

The above projects best represent my current skills and career direction. However, I have several other samples if you'd like to see more.

Tutorial Video for Minecraft Residence Plugin: I had a Minecraft server and YouTube channel where I posted videos about it. This one describes how to use commands for a plugin available on the server. The audience is a bunch of fairly young gamers who are already familiar with typing commands with parameters.

Account Access Quick Start Guide: This quick start guide walks employees through the process of using OKTA (single sign-on tool) to access their account. This guide was used by all employees during a company-wide transition and assumed some users were not very technical.

Google Apps eLearning: This eLearning course was created using Articulate Studio. It's purpose was to prepare about 15,000 employees for a company-wide transition of several communication and collaboration tools.

Google Apps Instructor-Led Training: This live-training presentation was presented as part of live company-wide transition of several communication and collaboration tools. The PDF includes notes for the instructor to read during the presentation.

Skills

• Software engineer level proficiency in C++, and ability to read and write code in C, JavaScript, Python, and other C-family languages
• Work with large teams (100+) contributing to version-controlled codebases with automated testing and deployment (Git/GitHub, Perforce, Subversion, Jenkins, Kubernetes)
• Success in deadline-driven Agile software development environments, collaborating with product managers, producers, engineers, and designers (JIRA, Confluence, Figma, Miro, Slack, Visual Studio, VS Code)
• Build rapport with engineering, production, design, and other teams to obtain an in-depth understanding of products/processes through user research and subject matter expert (SME) interviews
• Design, implement, and manage complex, evolving documentation projects throughout the software development life cycle (SDKs, APIs, CLIs, localization)
• Working within various formats and authoring environments (Markdown, HTML, CSS, JSON, XML/DITA, structured authoring environments)
• Producing documentation consistent with existing copy and patterns; Adhere to style guides, Microsoft Manual of Style for Technical Publications
• Experience with many open source tools; Doxygen, Swagger, OpenAPI, Postman, cURL, Mkdocs, Slate, Redoc, JSdoc, Sublime, Atom, ImGui, others

Education

Certificate in Technical Writing @ University of California, Riverside

• Technical Writing Project Management
• Documenting Policies and Procedures
• Creating Manuals and User Guides
• Technical Writing for Online Documentation
• Technical Writing Seminar

Completed Programming/API Technical Writing Courses @ Udemy.com

• Beginner API Development in Node, Express, ES6, and MongoDB
• The Art of API Documentation
• Learn API Technical Writing: JSON and XML for writers
• Learn API Technical Writing: REST for Writers
• Coding for Writers: Basic Programming (JavaScript)
• Beginner API devlopment in Node, Express, ES6, and MongoDB

Bachelor of Arts in English @ San Francisco State University