hi @kadser2_twitter did you do any documentation, product manual writing before?
Sam
@bitsave
Hello
alex9121
@alex9121
Hello everyone
Sam
@bitsave
I am finally in
alex9121
@alex9121
sorry Im not so helpful at it :D
Sam
@bitsave
I will be back soon to help with whatever documents you want prepared. :)
Tuna
@ngtuna
hi Sam. Welcome :wave:
Patrik Imiteme
@Imiteme
Hello
alex9121
@alex9121
hello Partrik
Tuna
@ngtuna
hi Patrik
alex9121
@alex9121
welcome, we will send more info about the technical content writer here for your review soon.
Tuna
@ngtuna
I am thinking of how we can collaborate on submitting/reviewing documents. Are you guys familiar with github ? Currently we manage our docs there at https://github.com/tomochain/docs repository. There will be pull requests for new docs and people can make reviews/comments on them
Otherwise, we have to figure out other ways to do that
Google Docs might be an option
Etienne Napoleone
@etienne-napoleone
I think GitHub is the best solution. I mean, we are searching for a technical writer, it should not be a problem.
Patrik Imiteme
@Imiteme
I agree with Etienne that github is the best solution for distributed collaboration
And git is not that hard to leanr
Tuna
@ngtuna
It's not required. A technical writer is person who can write about the output (tech) that software engineers collaborate to generate. It’s not neccessary to understand and use the protocol that software engineers collaborate to generate that output. But it’s much appreciated.
Etienne Napoleone
@etienne-napoleone
Yes I see what you mean. Although I think learning git basics (if necessary) is a really realistic and acceptable requirement for this position. Also, with GitHub branch protection options, it's really easy to protect our repos from unintentional wrong manipulation.
And I have a hard time imagining a sane collaborative workflow based on google docs. But maybe there is other unmentioned solutions?
Patrik Imiteme
@Imiteme
Atlassian has Confluence which allows collaborative editing. But it is a payed service. I use it for wiki and soon API documentation for our SaaS
Just curious. Will technical writers only take engineers output and formulate into readable documents or will there be space for more creative writing? I’m setting up a masternode on test just for experience and was thinking of documenting the monitoring aspect of it by integrating say Sentry.io to monitor NodeJS and MongoDB, Twilio for SMS alerting, etc. Also the security aspect by setting up 2FA for SSH access, Fail2ban, UFW, etc.
Tuna
@ngtuna
both
@alex9121 will share the doc later which describes our ideas on items we should write about and their priorities
it also includes what you mentioned. That would be great to have that kind of how-to/tutorial on different perpectives
Patrik Imiteme
@Imiteme
Great, thanks
Etienne Napoleone
@etienne-napoleone
Yeah used to use Confluence in my last company. I think it really shines when you use the whole Atlassian suit (Jira, etc)
Patrik Imiteme
@Imiteme
Yea, we use the whole suite and also our external dev team which makes it easy with Bitbucket & Jira. But since you are using Github it gives a lot of benefits to keep using it
Sam
@bitsave
I vote Google Docs. It’s better for sharing.
Patrik Imiteme
@Imiteme
I vote Markdown + Git. Maybe do branches and releases for different platforms that support Markdown as Github and DigitalOcean. And use tools for those who don’t such as markdowntomedium