ObsidianMD

3764 readers

1 users here now

Unofficial Lemmy community for https://obsidian.md

founded 1 year ago

MODERATORS

[email protected]

Obsidian for Writing Manuals (lemmy.world)

submitted 1 year ago by [email protected] to c/[email protected]

59 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 (43 children)

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.

[–] [email protected] 1 points 1 year ago (42 children)

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?

[–] [email protected] 4 points 1 year ago (41 children)

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

[–] [email protected] 0 points 1 year ago (2 children)

@gelberhut @effingjoe if I am a freelancer who gets paid for work done using #obsidian this doesn't apply. Correct me if I'm wrong.

[–] [email protected] 1 points 1 year ago

I see same text as you. As @[email protected]] already mentioned, it looks like you are working in an organization which includes less then 2 people. Your customers are not your employer.

[–] [email protected] 0 points 1 year ago (2 children)

@tamowafy @gelberhut @effingjoe AFAIK you need to be working in a for-profit organization with 2 or more employees to need a commercial license for #Obsidian.

[–] [email protected] 1 points 1 year ago

Agree.

[–] [email protected] 0 points 1 year ago (1 children)

@EpiphanicSynchronicity @tamowafy @gelberhut @effingjoe “the use of OBSIDIAN for the exercise of your own trade or profession for which you are compensated compensation (e.g. teamwork with colleagues, writing work reports, etc.) does not qualify as Personal Use”

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

Please provide a link to the quote.

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

@gelberhut Sorry, should have done that: https://obsidian.md/terms

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

Thanks! Strange that they did not put this in FAQ.

load more comments (38 replies)