![]() ![]() > What does this tool offer that would make it worthwhile to switch?Įven with the GUI stuff, I'm also wondering whether there's anything here enticing enough to switch. At that point you'd probably just opt to use Zendesk or whatever (boo). I know there are headless CMS tools out there that you can hook up to almost any SSG, but even getting that set up is way too big of a stumbling block for the kind of tech writer who doesn't want to tinker or use the CLI or any of that. Looks like this has a GUI, for one, which is potentially a big selling point for the not-so-technical crowd. > How does this compare to other well-established SSGs (Sphinx, Hugo, Jekyll, etc.)? These experiences gave us a long list of features to build and problems to solve." I'd be interested to hear more about specific lessons learned from these interviews and how Writerside addresses them. * From the overview page: "This project developed out of hundreds of customer interviews and 10+ years of working on the IntelliJ Platform documentation. What does this tool offer that would make it worthwhile to switch? * Most people who write a lot of docs are already invested in some documentation toolset or another. * 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. Linux: Same as above, but users may have to work through conflicts with your window manager.First, I sense that you should keep work on improving your mastery of English grammar.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |