this post was submitted on 12 Jul 2023
4 points (83.3% liked)

ObsidianMD

4682 readers
2 users here now

Unofficial Lemmy community for https://obsidian.md/

founded 2 years ago
MODERATORS
 

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.

you are viewing a single comment's thread
view the rest of the comments
[–] gelberhut@lemdro.id 5 points 2 years ago* (last edited 2 years ago) (30 children)

including work notes

This requires a commercial license. If your work does not meet few exceptions mentioned in the text I quoted above.

Sorry for bad news ...

[–] uberrice@feddit.de 4 points 2 years ago (5 children)

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 4 points 2 years ago (1 children)

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 2 points 2 years 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 :)

load more comments (3 replies)
load more comments (27 replies)