June 2019 Summaries

ReadMe has addressed inconsistencies in coding styles within its rapidly growing engineering team by adopting Prettier, an opinionated code formatter, to complement their existing use of ESLint. The challenge was incorporating Prettier without overhauling the entire codebase at once. To achieve this, the team opted for a gradual adoption involving automation scripts that utilize Git commands to identify and format only changed files, which are then processed with Prettier. This approach ensures new code adheres to Prettier standards while gradually updating existing code. The team created a Bash script to facilitate this process, allowing them to check and migrate files to conform with Prettier standards, which is now integrated into their continuous integration builds to ensure consistency over time.

ReadMe has recently revamped its changelog feature to enhance communication of product updates by making it more discoverable and user-friendly. The updated system includes a new embed widget that allows users to easily integrate the changelog into their websites, providing a more accessible platform for sharing updates. Additionally, the changelog posts now have a simplified format with five new types to choose from, making the information more skimmable. These enhancements aim to empower users by keeping them informed about the latest product developments, ultimately helping them make the most of new features.

ReadMe has introduced new features to its Project Metrics, enhancing the ability to analyze and improve documentation quality. The updated Metrics Overview provides a hierarchical layout for easier data comprehension, with detailed insights available by hovering over data points. A new dashboard offers Detailed Page Quality Metrics, including user responses, average scores, and identification of outdated pages. Users can now submit feedback after voting on page helpfulness, which provides valuable insights into customer experiences. These features are part of ReadMe's Enterprise plan, and existing customers can enable them through the Page Quality dashboard, allowing for informed decisions to better documentation.

Jon is originally from California and briefly lived in Brooklyn before moving back to the West Coast, which he fondly refers to as the #bestcoast. He enjoys watching genre films, appreciates bad puns, is a fan of hockey, and frequently talks about his elderly pug.

Gabe is originally from Oakland, California, and has spent most of his life in the Bay Area, though he has also lived in Portland, Oregon, and London, UK. He enjoys brewing beer and is passionate about discussing cars. In his free time, Gabe is often found indulging in food and drink or daydreaming about becoming a dog owner.