Technical Writing

TODO: Accept donations?

http://www.oilshell.org/blog/2020/07/blog-roadmap.html#accepting-donations-for-a-technical-writer

We need a "fiscal sponsor" for Github sponsors. And that makes sense anyway.

"Job" Description

This is of course premature because we have no money :)

• Essential:
  • Strong writing skills. Simplification is hard and requires deep understanding.
  • Able to write, debug, and explain code samples (mostly in shell, but other languages are a plus)
  • Able to create legible tables and diagrams (we don't have much prior art here, opinions on a toolchain are welcome)
  • Knowledge of programming languages and operating systems, and willing to learn way too much about Unix shell.
  • Comfortable with Markdown files in Git, as well as plain HTML
  • A decent eye for formatting and readability.
• Nice to have:
  • Can edit Python code and make PRs against the repo. e.g. for doctools/
  • Explain/advocate for Oil with their online presence
• Benefits:
  • Learning a ton about Shell, Python, C, C++, and Unix. Arguably these technologies are the foundation of modern computing! These skills are usable everywhere.

Would like to see: prior writing, blog posts, etc.

Related: Documentation Strategy