https://github.com/stephmarie17/writing-samples
Technical writing samples, written in markdown and hosted here on GitHub.
https://github.com/stephmarie17/writing-samples
documentation technicalwriting
Last synced: 4 months ago
JSON representation
Technical writing samples, written in markdown and hosted here on GitHub.
- Host: GitHub
- URL: https://github.com/stephmarie17/writing-samples
- Owner: stephmarie17
- Created: 2022-09-29T18:08:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T16:49:16.000Z (over 3 years ago)
- Last Synced: 2025-11-12T02:19:04.040Z (7 months ago)
- Topics: documentation, technicalwriting
- Homepage:
- Size: 919 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Technical Writing Samples
Below are a few samples of technical writing I have done. For additional examples, see:
- [Sentry Integration on Netlify](https://docs.netlify.com/netlify-labs/experimental-features/sentry-integration/)
- [PlanetScale Integration on Netlify](https://docs.netlify.com/netlify-labs/experimental-features/planetscale-integration/)
_Note that the links above are live! Updates may have taken place since I first created these pieces of documentation._
## Table of contents
- [Sample 1: Netlify Email Integration](#sample-1-netlify-email-integration)
- [Sample 2: Twilio Platform Advanced](#sample-2-twilio-platform-advanced)
- [Sample 3: Twilio Console Overview](#sample-3-twilio-console-overview)
## Sample 1: Netlify Email Integration
**This is a sample from documentation that I wrote for the [Netlify Email Integration](https://docs.netlify.com/integrations/email-integration/). This section describes how to use the add attachment feature of the Integration.**
### Add attachments to your email
When sending messages, you can also specify any files you’d like to attach. Using the snippet generated during the [email preview](https://docs.netlify.com/integrations/email-integration/#preview-email-templates), add the `attachments` property to the request `body`. The `attachments` property is an array that may contain three properties to attach your file: `content`, `filename`, and `type`.
| Property Name | Type | Description | Required |
| ------------- | -------- | --------------------------------------------------- | -------- |
| `content` | `string` | Base64 encoded string of the file | Yes |
| `filename` | `string` | The name of the file as it will appear in the email | Yes |
| `type` | `string` | the MIME type of content you’re attaching | Yes |
For example, the following handler function parses a `.pdf` file saved in an assets folder in the project. Nested in the body object is an `attachments` array that lists the `content`, `filename`, and `type` properties for that file.
```tsx
import { Handler } from "@netlify/functions";
import fetch from “node-fetch”;
import fs from “fs”;
const handler: Handler = async () => {
const file = fs.readFileSync(“./assets/example.pdf”).toString(“base64”);
const response = await fetch(
`${process.env.URL}/.netlify/functions/emails/forgotten-password`,
{
headers: {
“netlify-emails-secret”: process.env.NETLIFY_EMAILS_SECRET,
},
method: “POST”,
body: JSON.stringify({
from: “sender@myemailsender.com”,
cc: “recipient@youremail.com”,
to: “recipient@youremail.com”,
subject: “Password Reset”,
attachments: [
{
content: file,
filename: “example.pdf”,
type: “pdf”,
}
],
parameters: {
name: "Test",
}
})
}
);
const responseBody = await response.json();
return (
statusCode: response.status,
body: JSON.stringify(responseBody)
);
};
export { handler };
```
Refer to your email provider's documentation to verify which types of content are valid.
## Sample 2: Twilio Platform Advanced
**A hands-on course with a demo application developed for the Twilio Build Partner Community to teach advanced Voice and Messaging API features.**
### Overview
I created this project in collaboration with one of my team members at Twilio’s Center of Excellence. On this team, I crafted technical training courses designed for Partner Enablement. Twilio Platform Certification was a requirement for Twilio Partners to complete; this course was the next step in their learning journey to implement advanced API features.
To create this course, I learned the usage of Twilo’s Voice and Messaging APIs, including sending SMS alerts, incorporating transcription features, and managing and testing scheduled messages. To demonstrate these features to learners, I worked on the Messaging portion of a voicemail demo app.
The key features this app highlighted were:
- Recording messages and deleting recordings
- Creating transcriptions of voicemail recordings and deleting transcriptions
- Sending automated SMS alerts
- Scheduling SMS alerts
- Utilizing Messaging Insights via the Twilio Console
### Course preview
I provide the learner with the starter code for a voicemail application and explain the file structure. Next, the course introduces the learner to incorporating SMS functionality into the app, by sending an SMS alert when a new voicemail is received in the mailbox.
In this example from the course, I include two code snippets that I wrote to demonstrate how to include the necessary parameters for the SMS API. In addition to writing these snippets, I styled them in order to be embedded into the Rise course with appropriate colors and indentations for readability.
One of the key pieces of feedback that developers gave the Center of Excellence was the need for real-life examples of code, and this project provided useful examples that could be re-worked and applied to a developer's specific use case.
### Resources
To view the starter code that learners utilized for this course, access the GitHub repository [here](https://github.com/TwilioTraining/platform-advanced-voice). Note: only the starter code is available for me to share. the detailed course with additional code snippets are proprietary to the Twilio Build Community for Twilio Partners.
## Sample 3: Twilio Console Overview
**Technical training course developed for [twiliotraining.com](https://www.twiliotraining.com/store).**
### Overview
I developed this course using Articulate360 - Rise as an update to an existing version created by another team member. The Twilio Console is the web-based interface for utilizing Twilio products and APIs. The 2.0 version launched to the public in 2021, which required content maintenance to update the course. This course update was designed in order to reflect the latest changes to the Console.
The intended audience for the course are developers, administrators, and support teams. The process for this update included:
- Meeting with the product SME
- Auditing the existing course to identify and correct errors
- Creating new content for additional course modules and add more interactivity
- Editing the course and implementing feedback
- Deploying to the appropriate learning management systems
Below, explore an outline of this course.
### Learning objectives
I developed the learning objectives for this course based upon instructional design best practices.
### Navigation and site tour
This section breaks down the key sections of the updated Console interface, and includes an interactive heatmap to provide learners a self-guided tour of the application. This approach was essential due to a re-naming of a key feature of the console, and was helpful for users of the previous version to understand where content had moved within the application.
### Account quickstart
In this module, I created a step-by-step quickstart guide for upgrading Trial Console accounts to Paid Console accounts using an interactive stepper.
### Video tour
In this section, I collaborated with another technical writer on the team to write a script for a video tour developed in Storyline 360 of the Console including:
- Locating Account SIDs and Auth Tokens
- Monitoring API insights
- Setting up billing accounts
- Customizing the developer toolbar
- Accessing and submitting support requests
