Skip to content

ShilpaSandbox/technical-writing-portfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 

Repository files navigation

My Technical Writing Portfolio — GitHub Pages

I have created my GitHub Pages portfolio to showcase my work as a technical writer with a background in software engineering, Java, Python, and web design.

Included pages

  • index.md — landing page
  • samples/api-quickstart-taskflow.md — API quickstart sample (in progress)
  • samples/password-reset-help-article.md — end-user help article (in progress)
  • samples/release-notes-publishing-sop.md — internal SOP sample (in progress)
  • samples/release-notes-v4-2.md — release notes sample (in progress)
  • samples/developer-onboarding-case-study.md — documentation case study
  • _layouts/default.html — custom site layout
  • assets/css/style.css — custom styles
  • _config.yml — GitHub Pages configuration

How to publish on GitHub Pages

  1. Create a new GitHub repository, for example technical-writing-portfolio.
  2. Upload all files from this folder.
  3. In GitHub, open Settings > Pages.
  4. Under Build and deployment, choose Deploy from a branch.
  5. Select the main branch and the /(root) folder.
  6. Save the settings and wait for the site to publish.
  • Added an about.md page with my resume summary
  • Add one redacted real work sample
  • Create a second version tailored for API technical writer jobs

About

Portfolio

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors