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.

  • uberrice@feddit.de
    link
    fedilink
    arrow-up
    4
    ·
    1 year ago

    Eh. Theoretically, maybe. Practically, this is a problem of ‘what constitutes work use’.

    In my opinion, the work notes I take in obsidian are my personal notes. I found obsidian myself, and use it myself for taking notes for work. Stuff doesn’t get shared to coworkers, other than the actual text I am writing when I copy paste it out of obsidian.

    OP’s use case is a work use, in my opinion, as they are using obsidian to produce the output used for work.

    Same would apply if a team used obsidian for notes, encouraged use of it for everyone in the team, and/or uses shared vaults as a ‘wiki’.

    • gelberhut@lemdro.id
      link
      fedilink
      arrow-up
      4
      ·
      1 year ago

      I also see the definition of “work use” rather fuzzy. I have discussed this on Reddit some time ago. And conclusion was: if it is somehow work related you need a license, does matter if you share your voult or on not.

      Practically, obsidian does not hunt for people who use the soft without a proper license.

      On the other hand obsidian is developed by 2 people, I believe 3 now.

      Btw, your employer most probably will disagree with your definition of personal notes as well and the fact that you install obsidian on a work hardware.

      • uberrice@feddit.de
        link
        fedilink
        arrow-up
        2
        ·
        1 year ago

        Actually, my employer honestly does not care. My department specifically uses unmanaged devices, which we’re also explicitly allowed to use privately. The data on them is ours, we are encouraged to encrypt it with a personal key. ‘Non-personal’ data is stored on onedrive or our own gitlab instance.

        But I agree with you that most employers would :)

    • laurelinae@lemmy.world
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      ‘what constitutes work use

      It’s Commercial Use as opposed to Private Use.

      “Commercial use describes any activity in which you use a product or service for financial gain. This includes whenever you use software to create marketing materials, since those materials are used for business purposes with the intention of increasing sales.” - HubSpot

      In other words: You use it as a means to make money. Plain and simple.

      • uberrice@feddit.de
        link
        fedilink
        arrow-up
        1
        ·
        edit-2
        1 year ago

        That’s what obsidian state, yes.

        Now, what constitutes ‘making money’?

        If you use it to keep notes for your university courses, you effectively use it to further a cause which in the future will make you money, yet I’m sure you’d agree that doesn’t fall into ‘commercial use’.

        If I use it to organize the research I do - the knowledge of which I then use in a commercial project - does that constitute work use? In my opinion - yes, I get paid to do that research, but it’s knowledge for me, so no, it is not ‘work use’ to me.

        Next step - use it for notes specifically for a work project. As long as I am using it for myself and myself only, only sharing snippets of text that have no relevance to obsidian, not work use. Share a canvas created with obsidian? Work use. Share/publish a whole folder/vault as a wiki? Work use.

        • laurelinae@lemmy.world
          link
          fedilink
          arrow-up
          1
          ·
          edit-2
          1 year ago

          Now, what constitutes ‘being pregnant’? Does it begin when the egg is fertilized? Or does it begin when one has unprotected sex that will eventually lead to the egg being fertilized?

          And, what constitutes ‘being dead’? Is it when the brain doesn’t function anymore? How would we classify a person, who is comatose, catatonic or braindead, then? Does death commence when the last cell in the body is dead? Would one then be considered alive, when a patch of skin is not ‘dead’ yet?

          It’s nice to stake out the grey area of any topic, but if we are honest, it’s a never-ending game, that in your case intends to stall a conversation. Common sense tells you exactly what is work. If you are not sure, then discuss it with someone, ask a lawyer or make up your own opinion. Obsidian devs will not persecute anyone for using their software commercially without buying a commercial license. If you feel entitled to do so, then do so, but don’t try to disassemble the context to justify your actions.