4
mr-user
5y

I need to write the maintenance document in case I die.

Any idea what to include?

I have written a lot of software which include family business and other business depend on by myself.

I have an idea of adding my git user name and password. Email and social media user name and password.Configuration file/Configuration property. Troubleshooting information.Program overview.

Comments
  • 5
    @Jilano

    What should come after that?

    "You are the chosen one to clean up my mess.It's no use cursing me since I am already dead.

    Good luck!"
  • 0
    @Jilano Seriously what should I included?

    It will be the most important I have written up my whole life.
  • 1
    I am going to be a ghost which hunt both developers and managers.

    For developers : "There's a bug......F..i...x... it"

    For managers : "Chan..ge... the deadline...."
  • 1
    Just create a rabbit hole that will connect to an API to automatically announce you are dead.
  • 0
    @mr-user "it will be the most important I have written up my whole life" sounds kinda sad.

    But to your question: google "good readme" or look around Github for some popular open-source projects for inspiration. Usually there s sections like Getting Started, Local setup, Build, Deploy, Business logic, etc
Add Comment