25
Haxk20
7d

How do you guys fucking write long documents about projects ? I dont fucking get it at all. Its just pain to write it.

Comments
  • 6
    Fingers on keyboard and tap repeatedly for a while generally helps 😇
  • 3
    Dunno, I usually comment my code but never document it with manuals. Same with my server deployments.. bad habit, should probably learn to do it at some point :/
  • 2
    You'll know when something warrants it's own separate documentation. It'll be complex and weird or just massive amount of knowledge that needs to be written out nicely
  • 0
    You know what is pain? Rushing to write nice, well architectured code, polish it, groom it .... and at the end, a stakeholder tells you it's not what was asked, because you never clearly agreed on specs.

    Once you get through that a couple of time, you'll be super happy to get enough time to write that doc, and uncover all the details that might become an issue BEFORE you write all that code.

    Of course, it's better if someone else does it, and does it well. Shout out to great Product Owners.
  • 3
    Project documentation is the rare occasion where you can apply what you learned in school about writing: start with an outline, refine the outline until you have everything covered, then just fill in the blanks. The only problem is with things like API documentation the writing can get extremely repetitive and trigger your refactoring reflex.
  • 0
    vuepress is nice for documentation
    https://vuepress.vuejs.org/
  • 0
    @davenall wow, instant admiration!
  • 1
    I write docs/leave enough hints for myself so I don't need to remember details about projects that are "done".

    Also when ppl ask, I just say "here RTFM". Saves a lot of time and frustration in the long run by avoiding the "uh... How the fck is this supposed to work again?"
  • 2
    Actually yesterday someone asked about something I built. I just go yea here's the code (JS docs), here's how it's used (usage code).

    Now your smart enough to put it together, talk to your later
  • 2
    I'd rather have comprehensive and clear docs than long ones
  • 1
    Its document for school project about porting android.
Your Job Suck?
Get a Better Job
Add Comment