* How does this compare to other well-established SSGs (Sphinx, Hugo, Jekyll, etc.)?
Its docs are quite nice (as I would hope to see from a documentation tool) and a good demo of what it's capable of, but after spending a bit of time looking them over I still have several questions: So it seems like it's an opinionated integration between an editor and a Markdown-based static site generator with its own set of XML-based markup features. Docs For Developers is a pretty solid overview of the process that many TWs follow. I know this is boring work but it really is the foundation of communicating clearly.Īfter you've got those fundamentals down, you'll want to learn about the processes that technical writers follow to figure out what docs customers really need. * A Writer's Reference is a canonical reference text for looking up grammar rules. The best way to improve your writing is to practice and get feedback just like the best way to learn about programming is to create programs. There are probably a lot of online resources, too. English classes at community colleges, for example.
* Find some kind of program that forces you to write and get feedback on your writing.
* Technical Writing One by Google is a pretty good self-study course for practicing the fundamentals of writing mechanics. First, I sense that you should keep work on improving your mastery of English grammar.
