Rebecca’s Portfolio

Sample API Documentation

2021-03-08T03:30:42+00:00

To view my sample API documentation, click the links below. All of my API documents are written in accordance with the Open API 3.0 specification. I also published the documents on SwaggerHub, so that you can see the .yaml source file alongside its rendered output.

This document describes a mock API that allows users to create, delete, or retrieve a specified music playlist(s).
This document describes a mock API that returns movie details, such as ratings, release date, genres, cast, gross earnings, etc., for a given movie title.

Create a README.md for your GitHub profile

2021-02-27T03:30:42+00:00

This tutorial describes how to create a README.md for your GitHub profile using the GitHub website.

If you haven’t already, sign up for a GitHub account.
Sign in to your account and create a new repository by clicking New.
In the new window, take the following actions:

a. Name the repository after your GitHub username. For example, if your GitHub username is abc123, your repository name shall be abc123. This ties the new README.md file to your profile.

b. Make sure the repository is set to Public.

c. Check the box to Add a README file.

d. Click Create Repository.
See your new repository and README.md file.
Click the Edit README.md button to update your README.md file.
Add your content. You can use the GitHub template for inspiration.

Note: Text enclosed by <!– and –> is called a comment. Comments are notes to provide context to people reading your code and they won’t show up in the rendered output. If you use the GitHub template, make sure you delete the comment syntax; that is, the <!– and –>.
Click the Preview Changes tab to see the rendered version of your .md file.
Scroll down to add a commit message and description.

Note: Get in the habit of writing clear and concise commit messages–this makes your file history easier to follow. Your future self (and collaborators) will thank you!
Commit changes directly to the main branch.
Click the dropdown arrow next to your avatar in the top right. Select Your profile to see your new and improved GitHub profile with README.md file!

Why should technical writers use GitHub to host their portfolio?

2021-02-27T03:30:42+00:00

If you want to start a career in technical writing, you’ll need to develop a portfolio of writing samples.

One of the most effective platforms for sharing your technical writing portfolio is GitHub. In this article, we’ll discuss why techical writers should create and host their portfolio on GitHub.

Note: This article assumes you are pursuing roles in software or developer-facing documentation.

What is GitHub?

If you’re not familiar with GitHub, it’s a version control platform used primarily by the software developer community. GitHub users create a repository to store project files in a central location. By single sourcing content, multiple people can pull or push updates to a project and merge their contributions seamlessly.

If you’d like to learn more about GitHub, check out their free introductory course.

Now that you know what GitHub is, let’s discuss the ways that technical writers can benefit from using the platform.

Establish a presence in the developer community

Because GitHub is ubiquitous in the software developer community, it’s advantageous to introduce yourself on the platform. The best way to do this is by creating a publicly accessible GitHub profile.

Your GitHub profile contains a bio, a showcase of your pinned projects, a heatmap of your contribution activity, and a record of your most recent updates on the platform. You can also include external links to a writing blog or social media. In this way, a detailed GitHub profile acts as your technical writing portfolio, because it points to all of your technical writing experience.

Unlike a traditional portfolio, your GitHub profile is more than a collection of standalone documents. Instead, it’s dynamic–it demonstrates how you’re actively engaging in the developer community. It highlights not only projects you’ve accomplished in the past, but also projects you’re currently working on and projects you’d like to do next.

Find and collaborate on open source projects

Once you’ve increased your visibility by creating a profile, you can start extending your reach. After all, GitHub is a community of open source projects. If you want to grow your portfolio or gain experience, it’s easy to find new projects using the advanced search page. Simply add search tags to filter results to your particular skillset. For instance, to find API documentation projects, execute a search for API documentation with the label ‘help wanted’.

You can also search for opportunities to challenge yourself in something new. For example, if you want to get comfortable working with a new programming language like Python, you could filter search results by language.

Demonstrate the “Docs as Code” workflow

The Docs as Code workflow is a philosophy that says technical writers should treat documentation in the same way that developers treat code. In other words, technical writers can adopt the same tools and workflow that developers use. By using a common set of tools and workflows, you can streamline efforts and make documentation a cohesive part of every project.

In GitHub, you can practice using developer tools and processes. An example of each is outlined below.

Tools

Markdown is a human-readable markup language commonly used for developer documentation. It also integrates with GitHub really well. Not only can you publish Markdown source files to your repository, you can also host them on a website using GitHub pages. Demonstrate your use of syntax and versatility with Markdown source files that can be rendered on any static site.

Processes

Whether you use the GitHub desktop application or git commands in the command line, you’ll follow the same developer workflows. For instance, when you want to propose changes on someone else’s project, you can submit a pull request. GitHub describes this common developer workflow here.

As you can see, there are many benefits to hosting your technical writing portfolio on GitHub. By creating a GitHub profile, you can establish a presence in the developer community, find and contribute to open source projects, and follow common developer workflows. If you’re an aspiring technical writer, consider using GitHub to host your portfolio and continuously share, learn, and interact with the developer community.

Now that you know the benefits of GitHub, read the tutorial to Create your GitHub profile.

Set up your live stream using Twitch Studio

2021-02-27T03:30:42+00:00

Before you start

If you haven’t installed Twitch Studio, see Installing Twitch Studio. When you reach the app’s main screen, proceed with the tutorial.

Step 1. Capture gameplay

Open the game you want to stream. Return to the app and locate the Scenes panel. Under Main Screen Share, click Change Capture.

In the new dialog, select your game window from the list of applications. Click Next.

Step 2. Add a title

Give your stream a title, category, and one or more tags. You can also specify the stream language.

Note: Complete and accurate stream info helps make your content discoverable.

Click Done.

Step 3. Customize scenes

Select a scene from the Scenes panel to display it in the Stream Preview window.

If you want to make changes to the selected scene, click Edit Scene.

In the editor, you can fully customize your scenes. Some functionality includes:

Accessing Twitch Studio’s media library of images, patterns, and wallpapers.
Changing position, color, and content of text and screen captures.
Adding alerts and deciding how they show up in your stream.

When you’re done making changes, click Save to return home.

Note: What you see in the Stream Preview window is exactly what your viewers see when you go live. Take a minute to review your scenes and make sure everything looks good.

Step 4. Start streaming

You’re ready to go live! Click Start stream. Monitor and manage your stream at any time from the app. To end your streaming session, click Stop stream.

If you want to learn more, see the Twitch Studio user interface reference guide.

Twitch Studio user interface

2021-02-27T03:30:42+00:00

In the Scenes sidebar, see a list of your scenes. Right click a scene name to delete, duplicate, edit, or rename it. Click the plus icon at the bottom to add a new scene.

To share a game screen, select the Main scene and click Change Capture.

Note: To add screen capture to a particular scene, the scene must have a Screen Share layer. You can add or modify layers in the Edit Scene menu.

Stats Panel

Notice the stats panel at the top of the screen. These metrics will help you monitor your stream quality in real time. Check your frame rate, upload speed, and % demand on your CPU. You can also see how many viewers are tuning in to your current stream and the duration of the streaming session. Click the padlock icon to remove stats from the panel or drag and drop them in any order.

To the right of the stats bar, you’ll see a series of buttons. Use the Help button to report a bug, request a new feature, consult the FAQs, or even join the Twitch Studio Discord server to discuss all things Twitch Studio.

Click the Stars button to open the Twitch Studio news feed, where relevant articles and tutorials are posted.

Click your avatar to interact with your Twitch account. You can open your Twitch dashboard, which you’ll notice looks and behaves quite similar to the Twitch Studio interface. If you prefer sharing recorded content to live streaming, click Video Producer. Here, you can select videos you’ve recorded on Twitch Studio and upload them to your Twitch channel.

Activity Feed

When viewers take a new action to support your channel, you’ll receive a notification or alert in your Activity Feed. Examples of these actions include subs, follows, gifted subs, bits, hosts, and raids.

The difference between notifications and alerts is that notifications only show up in your Activity Feed, whereas alerts can display both in your Activity Feed and on your stream.

Click the 3 dots icon to toggle feed notifications and alerts on or off.

Note: To share alerts on a particular scene, the scene must have a Twitch Alerts layer. You can add or modify layers in the Edit Scene menu.

Chat

Interact with your audience! In the chat window, you have the ability to read and send messages to your viewers in real time. Click the cogwheel to open chat settings and enable moderation actions– like emotes-only chat 😮😮😮 or followers-only chat.

Stream Preview

Before you start streaming, check out your scenes and customizations in the Stream Preview window. You can also use Stream Preview while streaming to make sure your viewers are seeing everything you want them to see.

Stream info

Click the pencil icon to add or edit the title, category, and tags for your current stream.

Audio/Video Controls

Toggle your webcam on and off with a single click. Use the slider tool to adjust the volume on each audio device. You can also click the mic or speaker icon to mute either device.

General settings

Click the cogwheel to open the General Settings menu. Here, you can add transitions, add or swap an audio device, adjust stream quality settings, and customize hotkeys.

Now that you’re familiar with the Twitch Studio user interface, why not try some tutorials?

How to set up a livestream using Twitch Studio

Installing Twitch Studio

2021-02-27T03:30:42+00:00

Twitch Studio is a desktop application for live streaming and recording videos. It’s designed for people who are new to streaming and need a beginner-friendly tool to set up their first broadcasts.

What you’ll need

Microphone
Webcam
A Twitch account. If you don’t already have one, sign up here.

Download

Twitch Studio is available to download on both Windows and Mac. First, check that your operating system is up to date.

If installing on Windows:

Windows 7 or newer

For Mac users:

Mac Mojave 10.14 or newer

Then, download Twitch Studio here.

Installation

The first time you launch the app, you’ll be prompted to set up your microphone, webcam, scenes, and settings. Let’s walk through this process together.

Click to get started.
The app will detect a default microphone– keep the default or click Change mic to view other options. Select the microphone you want to use and click Continue to webcam.
If your webcam is connected, you should see it on the Webcam preview window.

Note: If you were not asked to set up a webcam, Twitch Studio might not have permission to access your webcam. Skip for now and we can grant permission in the app.
Notice you have three custom scenes to use during your live stream. Scenes are created using graphics from Twitch Studio’s media library. If you want to start exploring the media library now, click Customize Scenes.

a. In the new window, see your three scenes and a sidebar called Brand Assets.

b. Scroll through the sidebar to pick new colors, an accent image, wallpaper, and pattern.

c. Or, click the refresh logo at the top right to generate a random combination of colors and media.

d. Click Done.

You don’t need to finalize your scenes just yet. They can be fully customized in the app. Click Continue to Settings.
Lastly, let’s test your stream quality. (This might take a minute). Your stream settings will be optimized based on your current setup. You shouldn’t have to tweak any settings. Click Continue to App.

Note: Streaming can be demanding on your PC. If either the bandwidth test or the hardware check are “Poor”, you can still continue to the app. Just know that your stream may look choppy.

Once you’re in the app, see the tutorial How to set up live stream.