search

nus-cs2103-AY1819S2 / forum

CS2103/T discussion forum
6 stars 1 forks source link

Is "ab4 built it this way, we want to minimize change" a valid design consideration? #58

Open lingyanhao opened 5 years ago

lingyanhao commented 5 years ago

This turned out to be a real concern when building the project. However, such explanations in the developer guide would confuse any potential developers who did not see how ab4 was built.

Is this an acceptable explanation for the implementation portion for the developer guide?

okkhoy commented 5 years ago

@lingyanhao Can you be more specific what exactly are you talking about? I would need a context to say something about what you are asking.

Where did you find the particular line you mentioned?

lingyanhao commented 5 years ago

I do not intend to write that line exactly as it is- I am not done in writing that section of the developer guide.

The original ab4's design might not be optimal for me to mount a certain feature. However, changing the fundamental structure of ab4 would require a lot of change and I decided to just keep things as it is.

Is this a valid design consideration to write in the developer guide, at the cost of potentially confusing readers who might not be familiar with the implementation of ab4?

okkhoy commented 5 years ago

Ah! I see.

You can write the reason for your current design, and provide an alternative (which may be better, but for reasons that are your own, you didn't adopt it). This is acceptable.

However, just don't say things like: I found this implementation on XYZ place, so I used/implemented it 😜