Start Free Trial Book a Demo

Creating Tech Writing Portfolios with Docs as Code Tooling

Speaker

Svetoslav Pandeliev

Senior User Assistance Developer, SAP

Duration

30 mins

Presentation

Download Deck

In this webinar, Svetoslav Pandeliev, User Assistance Developer at SAP, discussed the different aspects of creating a technical writing portfolio.

He also shared why using docs as code tooling is a practical and quick approach for creating a technical writing portfolio, as well as discussed specifics such as knowing the tools you’ll use, criteria and sources for selecting a portfolio theme, organizing content and various hosting options.

Key takeaways

Using Docs as Code:

  • Leveraging Docs as Code tools can streamline the portfolio creation process, especially for those already familiar with these tools. It can also demonstrate proficiency to potential employers.

Alternative Portfolio Options:

  • Shared folders on cloud storage (e.g., Google Drive)
  • Static websites using HTML/CSS or website builders like WordPress.
  • PDF documents with links to online content.
  • Printed samples for in-person interviews.

Static Site Generators:

  • Popular tools for creating technical writing portfolios include Jekyll and MkDocs.

Content Organization:

  • Organize portfolio items effectively. Consider tagging samples for relevance to specific job applications while keeping everything in one portfolio.

Hosting Options:

  • GitHub Pages and Netlify are two popular and user-friendly hosting options for portfolios.

Next Steps After Publishing:

  • Get a custom domain for professionalism.
  • Start a blog to improve writing skills and showcase expertise.
  • Add an experience page detailing professional history and achievements.
  • Create content around the portfolio creation process itself as part of the portfolio.

Continuous Improvement:

  • Writing more and gaining experience in open-source projects can enhance portfolio content.

About the Speaker

Sveto stepped into the technical communication world in 2018 after spending several years in pre-sales and patent application drafting. He’s especially interested in everything related to docs as code because it removes one of the major hurdles in every tech writer’s job – getting those technical details from the subject matter experts. His on-the-job interests are mainly around creating developer tutorials and videos.

Ever since he switched careers, Sveto’s been telling everyone that he would’ve become a technical writer earlier had he known about the profession when graduating. Since October 2022, Sveto’s been part of the initiative committee of tekom Bulgaria, helping grow the technical writing community in the country and spread the word about technical writing among the younger generation.