Skip to main content

Dremio

RoleTechnical Writer
TypeFull-time
PeriodSep 2020 – Dec 2022

Background​

After Command Alkon, I wanted something harder. Not hard like "the documentation backlog is older than some of the engineers" hard. Hard like "the subject matter will break you if you don't learn it" hard. Database querying and management qualified.

Dremio hired me as their sole technical writer. They were upfront about their concern: I had no background in database systems at the level their product demanded. But they'd seen enough of my track record to bet on speed over pedigree. I hit every 90-day onboarding goal by day 30.

The ramp-up was steep in a way that previous roles hadn't prepared me for. I'd touched SQL in college and used RDBMS's intermittently throughout my career, but Dremio required depth I hadn't needed before. Custom SQL syntax, query optimization concepts, Apache Iceberg integration, data reflection management. I was learning the product and the industry at the same time, while also being the only person writing about either.

A one-writer documentation team supporting 150+ software engineers sounds like a math problem with no solution. In practice it meant triaging constantly: ongoing feature releases competed with years of documentation debt, and both needed attention on the same timeline. I documented third-party integrations (AWS Redshift, Glue, Microsoft SQL Server, Tableau, MongoDB), identity and access management including user, role, and object privilege hierarchies, and authentication and authorization workflows covering OAuth, private tokens, SSO, and SCIM with Okta. Plus every standard and custom SQL command the platform supported, in full syntax and functionality.

The security and access control documentation, in particular, sat right at the intersection of database administration and cybersecurity. Privilege management, ownership chaining, native column masking, row-access policies. Documenting these features meant understanding not just what they did, but the security implications of getting them wrong. (Getting them wrong in a database product is the kind of mistake that makes the news.)

I also contributed extensively to marketing content and blog posts on subjects including Apache Iceberg, access control, and AWS integration. And when Dremio decided to scale the writing team, I was part of the hiring process: screening, interviewing, and helping bring on a documentation manager and four additional writers.

What I Did​

  • Acted as sole technical writer for over a year while documenting a highly-technical database management and querying software product.
  • Managed a proverbial avalanche of documentation items while supporting a department of more than 150 software engineers.
  • Interfaced with SMEs, reviewed existing developer documentation on Atlassian Confluence, researched industry terminology and functionality, and regularly used build/staging environments or reviewing source code to better understand and describe software functionality in documentation.
  • Handled all release notes (sample) in addition to standard, SQL commands, and API documentation for bi-weekly cloud- and monthly premise-based releases. Tracked release items through Atlassian Jira.
  • Documented identity and access management (IAM) features including user/role/object privilege hierarchies, OAuth authentication, SSO configuration, SCIM and Okta integration, private token management, native column masking, and row-access policies. Samples: Access Management, Privileges, Okta SSO/SCIM, External Tokens, Private Link, Row & Column Policies.
  • Researched and wrote extensive content that was used throughout marketing and blog posts on the subjects of Apache Iceberg integration, access control (privilege) management for users/groups, AWS product usage, native column masking and row-access policies, SCIM and Okta integration, user session authentication, and more (Apache Ranger integration sample).
  • Participated heavily in the screening, interviewing, and hiring of a documentation manager and four additional technical writers.
  • Rewrote/updated significant portions of help content for the company's cloud-based application while on an aggressive deadline: 3 months and 300 help topics.
  • Developed and maintained a comprehensive SQL guide for end-users, enhancing their understanding and ease of use of the product. Samples: ALTER TABLE, CREATE USER, GRANT, GET GRANTEE PRIVILEGES, GET MEMBER LIST.
  • Led a project to improve SQL query examples, ensuring they were accurate, relevant, and useful for users.
  • Conducted regular reviews and updates of RDBMS documentation, addressing areas of confusion or difficulty for users.
  • Generated and maintained the documentation help site using Hugo, reducing build times by 60% compared to the previous static site toolchain.
  • Documented third-party integrations with AWS (Redshift, Glue, S3, IAM), Azure, and Apache Iceberg, covering configuration, authentication, and data source connectivity.

Key Skills​

Access Management · Adobe Creative Suite · Adobe Illustrator · SQL · API Documentation · Postman · JetBrains Rider · Microsoft SQL Server · Adobe Photoshop · macOS · Windows · CSS · HTML · Databases · Database Querying · Code Samples · JavaScript · Google Docs · Apache Iceberg · Apache Spark · Technical Writing · Release Notes · SCRUM · Agile · REST APIs · Atlassian Jira · Atlassian Confluence · Documentation · Enterprise Applications · Privilege Management · Private Tokens · OAuth · AWS IAM · AWS S3 · Quick-Start Guides · MySQL · Microcopy · Tooltips · Hover Text · UI/UX · Ownership Chaining · Process Improvement · SaaS · SCIM · Source Control · Version Control · Git · GitHub · Sprint Planning · Sprint Retrospective · Post-Mortem · SSH · SSO · Style Guides · User Content · Topic-Based Writing · E-Learning · Video Tutorials · Virtual Machines (VMs) · JSON · Markdown · Terminal · Parallels Desktop · Zoom · Amazon Web Services (AWS) · Amazon Redshift · Google Cloud Engine · Hadoop · OmniGraffle · Adobe Captivate · Copyediting · Proofreading · Content Management · Web Content · Engineering Documentation · Task Management · Hugo · Slack · Collaboration · Web Design · SDLC · Wiki · Installation Guides · Deliverables · Managing Deadlines · SME Interview · Daily Stand-up · Help Authoring Software · Online Help · User Guides · Diagrams · Research · Reference Guides · TOML · YAML