What nobody tells developers about documentation
Users don’t know what your product does, how to use it, or why they would use it. You need docs to explain this.
Read more [newsletter.posthog.com]
Posts tagged with documentation
The ingredients we used for our new Ray docs
– myray.app - submitted by Spatie
Discover our approach for our revamped Ray docs!
Read more [myray.app]
Join thousands of developers
Every two weeks, I share practical tips, tutorials, and behind-the-scenes insights from maintaining 300+ open source packages.
No spam. Unsubscribe anytime. You can also follow me on X.
Adding wire:navigate to Markdown links
– myray.app - submitted by Spatie
Discover how we've updated our new Ray docs!
Read more [myray.app]
An Engineer’s Best Tips for Writing Documentation Devs Love
Some good tips for writing effictive, human-friendly documentation.
Read more [thenewstack.io]
Good developer experience examples
A nice list of things to keep in mind when writing software or documentation.
Read more [leerob.io]
How To Create A GitHub Profile README
Monica Powell explains how to customize your GitHub profile page.
Read more [www.aboutmonica.com]
The mixin PHP DocBlock
When using PHP, you've probably used DocBlocks. They can be used to add additional information that can't be inferred by looking at the source code alone. DocBlocks can be used by IDEs, like PhpStorm, to improve autocomplete suggestions.
In this blogpost, I'd like to highlight a not so well known DocBlock: mixin.
Going serverless with Hugo and Netlify
Our team releases a lot of open source packages. All of our packages are well documented. For the smaller packages, we use a simple readme on GitHub. The bigger packages, like medialibrary and event projector get documented on our documentation site. We recently moved our site from a Digital Ocean…
Internal classes in PHP
Nuno Maduro, engineer at Algolia, explains what is the value of the @internal tag
The PHP @internal tag can be used to denote that the associated class/method is internal to the library. It's supported by PHPStorm and it warns people that those classes/methods are not meant to be used
Read more [nunomaduro.com]
Read-Writable Regular Expressions
Emily Shaffer makes the case for commenting regular expressions.
It’s probably not a good idea to encourage your coworkers to think critically about what life would be like if you got hit by a bus, but the good news is that you can simultaneously document your regular expression and teach your coworkers some regex basics, if you comment them carefully!
Read more [nasamuffin.github.io]
How to contribute to PHP documentation
Sammy Kaye Powers wrote a post on how to contribute to the PHP documentation.
If you've been wanting to contribute to PHP internals, starting with the documentation can be a great entry point; especially because it doesn't require dusting off those old C books from college.Phew! After reading this process my intentions of contributing melted away like snow in the sun. Editing the documentation should be much easier. I believe there would be more contributions if the docs would reside in a git-repo as markdown-files.But knowing where to start can be tricky since information on how to contribute to the docs is scattered across the internet.