![]() Pandoc has decent Asciidoc support, so you can transform to many other formats. HTML output is a snap (use data-uri to embed PNGs in the HTML as base64). You have lots of PDF pipelines, from DocBook-PDF (XSL) to Asciidoctor-web-pdf (Paged.js+CSS). In VSC you also have access to linters, git integration, style automation. It's directly derived from Docbook, which is probably the best-established XML pubs format, so you have a lot of tool support on that side for publishing.ĪsciidocFX is a good "learner's" editor, with an integrated DocBook-XSL based PDF toolchain.įor Serious Use, transition to Visual Studio Code (VSC): general purpose text editor with all sorts of productivity tools, the Asciidoctor extension is first class So, anyway, with that said, my recommendation.Īsciidoc is a lightweight markup language that can be used for content re-use, conditional content, and shared content components (like acronyms, warnings, etc). In this case, the constructed grammar is whatever drives your content conditions, so it's tightly coupled to whatever your product architecture is. Why does that happen? Basically, when you break up natural language into chunks, you substitute the grammar of NL with the constructed grammar of your system. ![]() all component content systems will need to deal with it in some way. DITA, S1000D, DocBook, ReStructuredtext, Flare. These will be critical questions regardless of what tool you end up with. How different are the configurations? At what point does a configuration become a different product or system? For component content (aka content re-use) to work in the long term, your product needs to be architected, or at least thought out carefully. ![]() But then you start doing electric engines as well as gas engines! That Engine - Install module (procedure, what have you) just got exponentially more complex for each delta that is introduced. Your leadership decides to re-use that module for all the manuals. What do I mean by that? Well, let's say you have an Engine - Install procedure. As you consider them, keep in mind that your requirement for re-use has an ancillary requirement that your product be architected. You're going to get a bazillion different suggestions from even more different perspectives. Posting of Job Opportunities are not of personal gain, even if OP is involved in the hiring process as its primary purpose is to provide visibility of employment opportunities to this community.Ĭontent from links that would be considered self-promotion are permitted for the purposes of discussion, so long as the content is discussed by copying and pasting a text post, not via the use of a link. This primary personal gain may be in the form of links to direct website traffic hits (such as to personal blogs, and/or product sites), text and/or images with the purpose of advertising services that the OP is involved with, and/or content that is deemed to be misleading to the community.ĭO enhance your text posts, if desired, using links to externally-available documentation, Websites, and other supporting information that helps to explain the text post. "Self-Promotion" is the action of sharing content to this sub-reddit through the use of a link (Any kind of link, regardless if it is a image, or a website/blog/advertisement), or in a text post, that directly benefits the OP for the primary purpose of personal gain. Posting a job opening? Please include at the beginning of your post title. Short, sweet, to the point, and accurate. You probably describe your work to other people as: "I write instructions for a living." Oversimplified? Yes. You may publish libraries of papers and manuals but your name will never be on them.
0 Comments
Leave a Reply. |