The Changelog: Software Development, Open Source

Devhints - TL;DR for Developer Documentation (Interview)

Feb 9, 2018
Rico Sta. Cruz, a graphic designer and web developer from the Philippines, discusses his innovative project Devhints, featuring over 365 cheatsheets for developers. He dives into the transformation of developer resources and the vibrant open-source community in the Philippines. The conversation touches on the art of documentation design, emphasizing the importance of visual tools and effective project presentation. Rico also highlights the significance of collaboration through contributions and mentorship in enhancing developer tools and resources.
Ask episode
AI Snips
Chapters
Transcript
Episode notes
ADVICE

Sell With A Fast Demo

  • Sell your project in the documentation by showing clear screenshots and short demos up front.
  • Make readers understand what it does within 20–30 seconds to increase interest and adoption.
INSIGHT

Design Signals Care

  • Thoughtful design signals care and increases community interest in a project.
  • Good visuals help convey intent and invite people to take a closer look.
ADVICE

Add Cheats Via Markdown PRs

  • Contribute cheat sheets as Markdown files in the repository and submit a pull request for inclusion.
  • Follow the repository's contributing guide and style cheat sheet to match site formatting.
Get the Snipd Podcast app to discover more snips from this episode
Get the app