Giter Site home page Giter Site logo

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

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

  • Work in deadline-driven Agile software development environments
  • Interact with various teams to obtain an in-depth understanding of products and processes
  • Conceptualize, define, schedule, and manage projects through delivery
  • Work in Markdown, HTML, CSS, JSON, XML/DITA, structured authoring environments
  • Knowledge of JavaScript/ES6, Node, Express, React, Redux, MongoDB, NPM
  • Read and write code samples in C, JavaScript, Python, and other C-family languages
  • Version control and collaboration tools; Confluence, JIRA, GitHub/Git, SharePoint, Subversion
  • Open tools; Doxygen, Swagger, OpenAPI, Postman, cURL, Mkdocs, Slate, Redoc, JSdoc, Sublime, Atom
  • Enterprise tools; Flare, Dreamweaver, Snagit, Photoshop, FrameMaker, Articulate, MS Office
  • Adhere to a style guide, familiar with Microsoft Manual of Style for Technical Publications

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)

Bachelor of Arts in English @ San Francisco State University

Mollie's Projects

battlenet icon battlenet

Bnet tech writing test. Click here for the published site: https://mollieswenson.github.io/battlenet/

foodtruck-api icon foodtruck-api

Foodtruck API using Node.js, Express, ES6, and MongoDB. I created this as part of Udemy course Beginner API Development in Node. The API allows GET, POST, PUT, and DELETE over HTTPS and includes authentication. Check out the docs!

git-wiki icon git-wiki

A revolutionary full-featured wiki for github pages and jekyll. You don't need to compile it!

imgui-docs icon imgui-docs

Documenting ImGui because I constantly forget how to use it

mkdocs icon mkdocs

Project documentation with Markdown.

react-video-search-app icon react-video-search-app

Video search app that makes calls to YouTube API and displays results as you type, using React. I created this as part of the Udemy course Modern React with Redux. See the docs for element descriptions. Check out the wiki! https://github.com/mollieswenson/react-video-search-app/wiki

slate icon slate

Beautiful static documentation for your API

soundboard icon soundboard

Soundboard I created for my D&D group. Uses Javascript, HTML, and CSS.

taxify-api-docs icon taxify-api-docs

This html API reference is written in Markdown and published using GitHub Pages. https://mollieswenson.github.io/taxify-api-docs

therapist-bot icon therapist-bot

Therapist bot I made as part of a basic programming course, plus documentation. Try a working demo therapy session at https://mollieswenson.github.io/therapist-bot/.

tic-tac-toe icon tic-tac-toe

Two versions of tic-tac-toe against the computer. Javascript, HTML, CSS.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.