16 min listen
#21: Awesome Developer Documentation for your OSS Project
#21: Awesome Developer Documentation for your OSS Project
ratings:
Length:
19 minutes
Released:
Jan 31, 2023
Format:
Podcast episode
Description
How did you like this episode??(upvote) ? (downvote)We describe our stack for writing documentation and which tools we can recommend to improve yours.One of a user’s first points of contact with your project will be through your project documentation. Even open source projects should try to make a good first impression here, but how exactly do you write great docs?Nowadays there are a gazillion different tools to write developer documentation. To save you some time, we’ll try to give you an overview and explain what worked for us and what didn’t.LinksReadme.com (https://readme.com/) Excalidraw (https://excalidraw.com/)Mermaid (https://mermaid.js.org )Docsify (https://docsify.js.org/#/)Our docs (https://openpodcast.dev/#/?id=main)HostsMatthias Endler (https://mastodon.social/@mre) Wolfgang Gassler (https://twitter.com/schafele)FeedbackEmail: echo@openpodcast.dev Twitter: https://twitter.com/OpenPodcastDev CreditsThe theme music is U.S. Army Blues - Kelly’s Number and is licensed under Public Domain Mark 1.0 License. How did you like this episode??(upvote) ? (downvote)
Released:
Jan 31, 2023
Format:
Podcast episode
Titles in the series (23)
#05 - Why there is no Google Analytics for podcasts? by TOPP - The Open Podcast Podcast