summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Johnson <nick@nicholasjohnson.ch>2023-10-31 00:00:00 +0000
committerNicholas Johnson <nick@nicholasjohnson.ch>2023-10-31 00:00:00 +0000
commit956a3bee42c38265cdc179514c566771fc4da807f3021d1432a7ce9bf0ca5670 (patch)
treebb9a260b3b83403c0c76138d548d11576d29b4831f86a599743e04e0d6956dc1
parentdb5d5026a914d47ff92830471c2581a9c106b3c342a0f337d46c16195b5d5ffd (diff)
Add correction notice about draw.io
-rw-r--r--content/entry/inception-rejecting-discord-drawio-and-visual-studio.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/content/entry/inception-rejecting-discord-drawio-and-visual-studio.md b/content/entry/inception-rejecting-discord-drawio-and-visual-studio.md
index bbceaf9..d6b96f2 100644
--- a/content/entry/inception-rejecting-discord-drawio-and-visual-studio.md
+++ b/content/entry/inception-rejecting-discord-drawio-and-visual-studio.md
@@ -26,6 +26,8 @@ Project II was a similar story to project I except that I was in a group of thre
Again, it was awkward asking everyone to use Riot when they had never heard of it. I had a hard time finding a soft way to propose using it when I wasn't willing to accept a proprietary alternative. But my two group members were willing to use it. I again was able to convince them to exchange device keys in person for an encrypted room. So far, all was well.
### Documentation
+Edit (31-10-2023): Please disregard the part in this section where I claimed that draw.io was proprietary software. It has been brought to my attention that draw.io is free software and was at the time of writing as well. I don't recall what led me to believe otherwise. I apologize for any confusion I may have caused over this.
+
And so we began our documentation. This time, I was not our project lead. Another team member had more time to work on the project, so he took the initiative. He was very diligent and before we had even started writing code, we ended up with an estimate of close to eighty classes total. We had polished UML diagrams for all those classes including package diagrams and UML class diagrams and a three tier architecture established before a single line of code was written. I was very satisfied with that. For my diagrams, I used [Dia](http://dia-installer.de/) and my teammates used [draw.io](https://app.diagrams.net/). Dia was difficult and annoying to use as far as alignment goes. It might have been due to my inexperience never having used it before, but I used it anyway for freedom. Draw.io is not free software. It uses proprietary JavaScript and requires a software license to purchase the app. Nevertheless my teammates were able to at least export their diagrams in png format so I could see them using free software. Our project lead claimed to have used Dia before and said it was too inconvenient usage-wise.
The deliverables for the project were scheduled in such a way that we had to do all the documentation before starting the project, and continually revise documentation as the project went along. Our documentation was so effective that I trust we could've handed it to any other group in the class, and they would have been able to implement our entire design. Some of the documents were done using Google Docs regrettably. I strongly suggested using [Sandstorm](https://sandstorm.io/) instead since it is free software and doesn't require proprietary JavaScript in the browser. That did not end up happening since I had other classes to worry about and we were crunched for time. If I could retake the class, I would have created a separate shared repo for documentation and used a word processor for editing instead. Our team lead did not see this as viable since he felt we needed to be able to see everyone else's changes in real time. There was a lot of talk about using Sandstorm, but I was never able to make it happen.