Technical Writing Sandbox
Not much to see here--just some artifacts of a software engineer's learning journey to improve their technical writing skills.
This is a static site/repository to:
- Write notes from learning materials
- Apply lessons learned to this repository
- Gain experience with popular documentation tools (Jekyll, Eleventy, Docusaurus, Vale, etc.)
- Build out a portfolio as a feral documentarian
const writeBetterDocs = (mediocre) => {
return mediocre
.read(books)
.attend(classes)
.lint(prose)
.with(styleguides)
.practice(writing)
.practice(writing)
.practice(writing)
.then(() => {
return 'Clear and precise documentation!'
})
}