Marco Spinello

As a senior technical writer in a team of 2, we collaborate with multiple engineering teams.

My role covers the following:

• Co-owner and co-author of the developer documentation available on https://sanity.io/docs
• Author, review, and maintain procedural (tutorials, how-tos, recipes), conceptual (architecture, high-level overviews), reference, and changelog documentation.
• Audit the existing documentation corpus to recommend information architecture and content strategy approaches to improve effectiveness, navigation, and findability.
• Author and promote adoption of a style guide to align documentation contributors (for example: engineering, product, design), and to establish shared best practices for a consistent and recognizable tone of voice.

As a senior technical writer in a team of 2, we collaborate with multiple engineering teams.

My role covers the following:

• Co-own and co-author the developer docs on the Miro Developer Portal: https://developers.miro.com/
• Author and maintain procedural (tutorials, how-tos, recipes), conceptual (architecture, high-level overviews, use-case/scenario-based), reference, troubleshooting, and changelog docs.
• Provide support to external developers through the online forum and on Discord. Main support areas: build apps and integrations for Miro boards using the Miro Web SDK, REST API, and API clients.
  

As a member of the Technical Documentation Guild:

• Collaborate with engineering teams to start, update, and maintain internal docs (Golden paths + Backstage).
• Organize and teach the Google Technical Writing One and Two courses for software engineers.

As a volunteer:

• Kick-start and drive the Miro musicians club to hold jam sessions and help colleagues get in contact with other musicians at Miro.

2021 - 2021:

• From docs-as-code (2015) to wiki (2018), and back to docs-as-code. Docs-as-code/take 2 (with feeling, this time) uses GitLab, Asciidoc, and Antora. Team initiative.

2020 - 2021:

• Kill your darlings: tear down the docs to improve scalability, maintainability, searchability, and user-friendliness. Team initiative.

2019 - 2021:

• Improve automation in docs processes.
• Publish OpenAPI-based API docs in Confluence.
• Onboard and train new writers.
• Deliver cross-team, cross-department writing trainings to promote collaborative docs.

2018 - 2020:

• Jump-start the company band.
  Initially thought as a one-off project, it has evolved into a collaborative initiative to make music with colleagues.
  We play gigs at company events, and we practice regularly.
  The band relies on a core group of people driving rehearsals, schedules, and song selections.

2018:

• Migrate from doc-as-code to DocOps.
• Atlassian Confluence is the core tool in our docs toolchain, and DocOps is the strategy we apply to drive our docs processes.
• DITA best practices, minimalism, and single-source/multiple outputs are our main authoring guidelines.

2015-2016:

• One year after starting documenting a new product from scratch, a lone tech writer can manage ~15K+ text, image, and PDF files with no database:
• Jekyll + Liquid templating + Markdown/YAML/JSON + GitHub help me manage content.
• Jenkins crunches docs builds automaGically.
• Single-source, multiple outputs (HTML and PDF).

• Document Adyen APIs and related products and services for technical audiences (developers and integrators).
• Interview SMEs to obtain information such as specs, features and functionality, business value.
• Plan and drive a migration of the existing docs from a non-structured (Word, PDF) to a structured environment (wiki).
• Implement single-source authoring, task-oriented, structured writing, content reuse, modularity (every page is page one). Use plain English to facilitate cross-collaboration synergies and actuate processes both vertically and horizontally across the organization. No, really, just plain English to really get stuff done.
• Automate wherever possible: JavaDoc API docs generation, Swagger API docs generation and consumption, GitHub code example snippets.
• Push email notifications to relevant stakeholders when docs change.

• Author in DITA XML to produce multiple output docs (PDF, CHM, HTML).
• Apply Agile docs methodologies and work with Scrum sprint iterations.
• As a member of Product Documentation Delivery define, communicate, and manage product line docs plans and schedules.
• Provide input and feedback to drive overall design and set functionality scope.

• Document Spil Games APIs for third-party game developers (API reference, tutorials, release notes, FAQs).
• Improve usability and conduct information design research for all technical deliverables related to the Spil Games Game Developer Platform product.
• Edit, standardize, and update materials prepared by other writers and internal stakeholders such as PMs and SMEs.
• Study drawings, specifications, mock-ups, and product samples to integrate and delineate technology, operating procedure, besides production sequence and detail.