ObsidianMD

4119 readers

2 users here now

Unofficial Lemmy community for https://obsidian.md

founded 1 year ago

MODERATORS

grabyourmotherskeys

Pexily

Obsidian for Writing Manuals (self.obsidianmd)

submitted 1 year ago by hutchmcnugget to c/obsidianmd

42 comments fedilink hide all child comments

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

[–] [email protected] 4 points 1 year 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'.

[–] laurelinae 1 points 1 year ago (2 children)

‘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.

[–] [email protected] 1 points 1 year ago* (last edited 1 year ago) (1 children)

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 1 points 1 year ago* (last edited 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.

load more comments (2 replies)