Creating a Tech Writing Portfolio with Docs as Code Tooling
- Workshop
- Career Development
- 07. June
- 09:15 - 10:45 AM (CEST)
- Venus
- finished
-
Svetoslav Pandeliev
- SAP Labs Bulgaria
Contents
Although the topic of portfolios constantly circles around the tech writing space, discussions are almost entirely focused on the questions “What to include in my portfolio?” and “How do I create samples for my portfolio if all my work is covered by NDAs?”. In this workshop, we’ll actually create and publish a portfolio website by following docs as code practices.
Takeaways
The key takeaway from this workshop is that every participant walks away with a basic portfolio website published on the Internet. Additional takeaways: get started with SSGs, markdown, HTML + CSS, and GitHub.
Prior knowledge
What you'll need:
- Laptop – bring your computer, we’ll be doing some activities
- Text editor – Notepad++, Sublime Text, Atom, Visual Studio Code, etc. will do
- Git – a popular version control system. For Windows: gitforwindows.org. For Mac: git-scm.com/download/mac .
- GitHub profile – Go to github.com and create a profile if you don’t have one yet.
- Jekyll – it’s one of the most mature static site generators, has detailed documentation and big community to ask for support, and it’s extremely simple to get started with it. jekyllrb.com/docs/installation/windows/ provides installation instructions for windows users and jekyllrb.com/docs/installation/macos/ provides installation instructions for Mac users.