5
mjoellnier
128d

Do you guys know any tool for documentation in a private side project with two guys?

Comments
  • 3
    Docuwiki
    basically ur own wikipedia, text based storage, written in php
  • 1
    Another vouch for docuwiki, it's quite nice 👀
  • 1
    At the first look it looks good indeed - I'll definetly give it a deeper dive into it
  • 1
    Why not markdown files in a docs/ folder? Prepare the docs for eventual release to public and also gain experience in writing and formatting docs for stuff like github…

    PS: you also get the benefits of git versioning for files, as they are part of the project :)

    PS2: no need for extra software and hosting
  • 1
    Also, write javadoc style comments to autogenerate the class/method/property/return value stuff. When the project grows you might need structured docs
  • 0
    @balaianu good call! Thought about that mainly because of no extra software or hosting but I think without something like Github we'll struggle to keep the overview of the MD files - how do you organize them?

    @Hakash yeah absolutely! Most of the time a good Java doc comes in handy even in the beginning stage of projects
  • 0
    @mjoellnier Well, you said private, so you can try something like Bitbucket, that has free private repos. As for organising, just follow the module structure of your code at first...and adjust as your docs grow.
  • 1
    Confluence
  • 0
    Markdown with Mkdocs (can be hosted in Read the Docs) or with Docsify
  • 0
    @balaianu I think that will be the way we will start to go. Md files should also be pretty good transferable even if we decide to change

    @NefixEstrada We'd like to go along without a hosting necessary on our sides - but I will also keep it in mind
  • 1
    @xalys when our idea turns out to be as awesome as we think it is this will be an option - but as far as I can say right now it's not the right thing for a poor students side project ^^
  • 1
    @mjoellnier Great, have fun on your project :)
  • 0
    @balaianu thanks mate! Hopefully I can tell a bit more about it in the future :)
  • 0
    Asciidoc
Your Job Suck?
Get a Better Job
Add Comment