Menu

Looking for technical writing / editing experience

2016-04-19
2016-04-19
  • Chris Sirrs

    Chris Sirrs - 2016-04-19

    Hello,

    I am a recent university grad interested in acquiring some volunteer experience in technical writing. If anyone is looking for help with documentation, feel free to contact me.

    Thanks!

     
  • Jeremy Davis

    Jeremy Davis - 2016-04-19

    Hey Chris,

    I work with TurnKey Linux: https://www.turnkeylinux.org/

    Like many open source projects our docs are really sad :(

    We do have some good content but there are lots of gaps and our docs are spread around all over the place... Some of it's really out of date, most (if not all) of it could really be improved.

    We plan to tidy it all up at some point and move all our docs onto GitHub and then build the docs hosted on our website with Sphinx. But we don't have any timeframe yet for that, so it could be a while away.

    In the meantime we would be super excited with anything you were willing to contribute; including:

    • reviewing, updating and revising current docs
    • creating new docs to fill existing gaps
    • creating new docs from existing content (much of our docs are actually past blog posts)
    • starting the doc organisation process
    • pretty much anything else doc related...

    Currently we have:

    Most of our docs in a (Drupal based) wiki on our website:
    https://www.turnkeylinux.org/docs

    Numerous blog posts that (somewhat) double as documentation); e.g.:
    Using our Docker builds: https://www.turnkeylinux.org/blog/announcing-docker-builds
    Using our Xen builds: https://www.turnkeylinux.org/blog/announcing-xen-builds

    Then we have some docs already on GitHub. E.g.:
    TKLDev (our build environment) docs: https://github.com/turnkeylinux-apps/tkldev/tree/master/docs
    OpenVPN appliance docs: https://github.com/turnkeylinux-apps/openvpn/tree/master/docs

    Let me know if you're interested. Either post here or email me jeremy@turnkeylinux.org

    Cheers,
    Jeremy

     

    Last edit: Jeremy Davis 2016-04-19

Log in to post a comment.

MongoDB Logo MongoDB