my-writing

KO | EN

gitlite — search

#python #hacktoberfest #ai #golang #android #deep-learning #docker #nodejs #java #awesome #cli #vue #awesome-list #openai

(★ 10)

This is a repository to store and manage my technical writing portfolio.

my-writing 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# About the My Writing Repo

This repository contains writing samples that demonstrate my technical writing abilities.

If you want to learn more about me, my background, and my documentation process, check out my [Wiki](https://github.com/heykayla/my-writing/wiki).

## Documentation types

My technical writing samples are categorized into the following documentation types:

- Explainers
- How-tos
- Quickstart guides
- Reference guides
- Templates
- Tutorials

For all my writing samples, I followed the [Google developer documentation style guide](https://developers.google.com/style).

## My writing samples

| Document | Documentation type | Description |
| ------------- | ------------------ | ----------- |
| [What You Need to Know About QR Codes](https://github.com/heykayla/my-writing/blob/main/explainers/explanation-what-you-need-to-know-about-qr-codes.md) | Explanation | This explanation article is written in Markdown and provides information on QR codes. I used VS Code and the [explanation template](https://github.com/thegooddocsproject/templates/tree/dev/explanation) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this explanation article.|
| [How to Create and Push Files to a Remote Repository](https://github.com/heykayla/my-writing/blob/main/how-tos/how-to-create-and-push-files-to-a-remote-repo-tutorial.md) | How-to | This how-to article is written in Markdown and provides steps for creating files from your local computer and uploading them to your remote GitHub repository. I used VS Code and the [how-to template](https://gitlab.com/tgdp/templates/-/blob/main/how-to/template_how-to.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this how-to article. |
| [DEV User Interface Components](https://github.com/heykayla/my-writing/blob/main/references/reference-dev-ui-components.md) | Reference | This reference article is written in Markdown and provides information on the user interface (UI) elements of the DEV website homepage, a social media platform for software developers. I used VS Code and the [reference template](https://gitlab.com/tgdp/templates/-/blob/main/reference/template_reference.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) create this reference article. |
| [Git Commands](https://github.com/heykayla/my-writing/blob/main/references/reference-git-commands.md) | Reference | This reference article is written in Markdown and provides information on common Git commands. I used VS Code to create this reference article. |
| [Marketing Campaigns Release Note](https://github.com/heykayla/my-writing/blob/main/release-notes/release-note-marketing-campaigns.md) | Release Note | This release note is written in Markdown and provides an overview of a hypothetical product's new features, improvements, and bug fixes. I used VS Code and the [release notes template](https://gitlab.com/tgdp/templates/-/blob/main/release-notes/template_release-notes.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this release note. |
| [Contributing Guide](https://github.com/heykayla/my-writing/tree/main/contributing-guide) | Template | This contributing guide and its accompanying guide are written in Markdown. I created this template when I was a contributor to [The Good Docs Project](https://www.thegooddocsproject.dev/). The purpose of this template is to provide a predefined format for open-source projects to outline and explain guidelines to prospective contributors. I used VS Code to create the template and accompanying guide. | 
| [Clone a GitHub Repository with GitHub Desktop](https://github.com/heykayla/my-writing/blob/main/tutorials/tutorial-clone-a-github-repo-with-github-desktop.md) | Tutorial | This tutorial is written in Markdown and provides detailed instructions on cloning a remote repository to your local computer with GitHub Desktop. I used VS Code and the [tutorial template](https://gitlab.com/tgdp/templates/-/blob/main/tutorial/template_tutorial.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this tutorial. |
| [Create and Customize Your DEV Account](https://github.com/heykayla/my-writing/blob/main/tutorials/tutorial-create-and-customize-your-dev-account.md) | Tutorial | This tutorial is written in Markdown and provides detailed instructions on creating a DEV account with a GitHub account. I used VS Code and the [tutorial template](https://gitlab.com/tgdp/templates/-/blob/main/tutorial/template_tutorial.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this tutorial. |
| [Create a GitHub Profile README](https://github.com/heykayla/my-writing/blob/main/quick-starts/quick-start-creating-a-github-profile-readme.html) | Quickstart | This quickstart guide is written in HTML5 and helps users to set up a profile README in GitHub. I used VS Code and the [quickstart template](https://gitlab.com/tgdp/templates/-/blob/main/quickstart/guide_quickstart.md?ref_type=heads) from [The Good Docs Project](https://www.thegooddocsproject.dev/) to create this quickstart guide. |

my-writing

my-writing 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

my-writing

my-writing 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README