---
title: "Discussion on \"Documentation in Software Engineering\" | Hashnode"
description: "Discussion on \"Documentation in Software Engineering\". Developers in general hate documentation, it feels like they're writing a business proposal and it's just too stressful. However, having good documentation is key to building and sustaining any product.\nIntroduction\nSoftware Development Life Cycle (S..."
url: "https://hashnode.com/posts/documentation-in-software-engineering/5f6d12a0005ded5336f6f533"
---

[Feed](https://hashnode.com/feed) /

Discussion

# [Documentation in Software Engineering](https://blog.murewaashiru.com/documentation-in-software-engineering?utm_source=hashnode&utm_medium=feed)

Developers in general hate documentation, it feels like they're writing a business proposal and it's just too stressful. However, having good documentation is key to building and sustaining any product. Introduction Software Development Life Cycle (S...

Sep 24, 2020 · 5 min read · blog.murewaashiru.com  
Updated Jan 12, 2021  
Read the article

-   [#the-technical-writing-bootcamp](https://hashnode.com/tag/the-technical-writing-bootcamp)
-   [#documentation](https://hashnode.com/tag/documentation)

## Written by

[Murewa Ashiru](https://hashnode.com/@murewaashiru)

@murewaashiru

  
[View profile](https://hashnode.com/@murewaashiru)

Software engineer | IT Business Analyst | Technical Writer

I am a software developer and project manager; passionate about solving problems through IT.

## Responses 3

Markdown supported · ⌘↵ to post

[Dinys Monvoisin](https://hashnode.com/@dinmon)

[Sep 29, 2020](https://hashnode.com/posts/documentation-in-software-engineering/5f6d12a0005ded5336f6f533/comment/5f730ea9f955ec0a130f607a)

Everyone knows that software documentation is good, but how do you write a good software documentation? Any tips?

[Murewa Ashiru](https://hashnode.com/@murewaashiru)

[Sep 30, 2020](https://hashnode.com/posts/documentation-in-software-engineering/5f6d12a0005ded5336f6f533/comment/5f730ea9f955ec0a130f607a#reply-5f74b50eb48bd01f316605b6)

Hello Dinys.

Here are a few things to consider

1.  Know who your target audience is and write to fit their needs.
2.  Know what the best format for presentation is e.g word document, UML diagrams, spreadsheet, etc.
3.  Be as precise as possible but don't leave out important information.
4.  Be consistent in your style. Have a template for each type of document that you use.
5.  Always version your documents for easy referral. New versions should note the changes required.

[Ebi Ere](https://hashnode.com/@sorcerer)

[Sep 26, 2020](https://hashnode.com/posts/documentation-in-software-engineering/5f6d12a0005ded5336f6f533/comment/5f6ef198ade1fb598d439d58)

Even a founder leaves the company. Keep it up.

[babalola lateef](https://hashnode.com/@delatbaba)

[Sep 25, 2020](https://hashnode.com/posts/documentation-in-software-engineering/5f6d12a0005ded5336f6f533/comment/5f6d7f63005ded5336f6f7ff)

Thank you for sharing this great article 👍