bmwinstead / enigma-project

Other
1 stars 1 forks source link

Documentation (UG and MTP): Formatting between documents #5

Closed ikleyjl closed 11 years ago

ikleyjl commented 11 years ago

Reviewer Wolfe says: "An overall consistency note… Your documents look really great, and quite clean, but for extra polish, you might consider having one person format your documents for consistency. Your documents each look good on their own, but almost don’t look like products of the same project once you get past the cover page."

Response: My knee-jerk response is that a Master Test Plan is an internal document while a User's Guide is an end user document, so by their nature they're not going to look the same. If we want to change the format on the MTP to match the UG, I don't have a problem with it because it's not that big a deal, but on the other hand... it's not that big a deal to not change it, because they're documents intended for (theoretically) different audiences.

wadolph commented 11 years ago

I agree with your train of thought and I don't see a need to synchronize formatting.