Skip Navigation

Obsidian for Writing Manuals

Is Obsidian a good tool to use for writing technical manuals? I would like to write an Operation Manual for municipality's water system. There will be embedded screenshots and some links to other sections of the document.

Ideally we could "publish" to offline html. The customer would also like a printed manual.

If Obsidian is no good, I would love suggestions on software you have used to write short manuals with pictures, preferably not Word.

59
59 comments
  • Check if makrdown formatting functionality is enough for you or not - it is pretty limited.

    Do not forget to purchase proper obsidian license - your usecase is not covered by a free version.

    • Do not forget to purchase proper obsidian license - your usecase is not covered by a free version.

      Can you elaborate on this? Are you referencing their "Publish" feature?

      • No. I mean the following: "Commercial Use Licenses are required whenever Obsidian is being used for work for a business with two or more personnel. Sole proprietorships or other one-person organizations do not require a Commercial Use License. Work for educational purposes does not require a Commercial Use License.

        Commercial Use Licenses must be purchased on an annual and per user basis. Commercial users must purchase at least as many licenses as the number of people who will be using Obsidian.

        You may use Obsidian commercially for free for 14 days to evaluate the app before purchase."

        see: https://obsidian.md/license

  • I don't see what function or feature would be missing from Obsidian that would make it inappropriate to use. There's even a plugin to export html files.

59 comments