Skip to main content Link Menu Expand (external link) Document Search Copy Copied

About

This section is about the project, references, and the author. Here you can learn the details about how the project was created, why this topic was selected, and what tools were used.

Here I’d like to mention Kacper Bojakowski’s project Technical Writing for Translators as a source of inspiration for the form of my project, even though the topic is radically different.

Project

This guide was created as a graduation project as part of the Technical Communication studies at the Vistula University during the academic year 2022/2023.

Here are some details about the project:

Title: How do CATs process Markdown files?

Personas: translators who need to translate an .md file and technical writers who need to send .md files for translation

Tools: Markdown, Jekyll, Just the Docs

Publishing: GitHub Pages

Software — Primary: Phrase, Trados Studio, Wordfast Pro

Software — Tools: Canva, GitHub Desktop, Microsoft Excel Obsidian, Snip & Sketch, Table to Markdown, Total Commander, Visual Studio Code

Supervisor: Marta Bartnicka

Peer Reviewers: Justyna Kula, Monika Klimek

References

  1. G2, Listings of CAT software
  2. “HTML, Britannica”
  3. “Markup language”, Britannica
  4. Collapsed sections
  5. Daring Fireball
  6. Keyboard glyphs
  7. Markdownguide.org
  8. Tabor, Jared “CAT tool use by translators: what are they using?”, Proz.com, access 2023-05-16

Author

Hi, I’m Paweł and I’m a technical translator with 10 years of experience. I translate mostly instruction manuals and other types of technical documentation. In 2022, I decided to enrol on the Technical Communication studies at the Vistula University to try my hand at creating technical documentation rather than translating it. Now, I’m ready to embark on a new adventure bringing a translator’s perspective to the table.

Useful links and contact:

Version

Current version: 1.2

Version no. Date Changes
1.0 05.06.2023 Release
1.1 23.01.2024 Updated table of contents in Results pages
1.2 24.01.2024 Changed headings to one level down

Go to: Main page