You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
- This answer is "correct", but doesn't really think beyond that. What about an architecture design for example? What about developer/business turnover? How is this handled by lots of quality unit tests?Paul– Paul2012-08-29 14:10:54 +00:00Commented Aug 29, 2012 at 14:10
- @Paul: It is a good idea to have VERY high-level architecture diagrams, along with very light-weight coding standards, for new-comers. I've found that a good way to keep those documents up-to-date is to keep them in a wiki and get each newcomer to update where they find it is dated. But this question was about up-front design documents specifically.pdr– pdr2012-08-29 14:31:42 +00:00Commented Aug 29, 2012 at 14:31
- I still stand by what I'm saying. Change Architecture to whatever the business wants to call it, and change unit tests to regression tests (automated?) and it applies.Paul– Paul2012-08-29 17:03:46 +00:00Commented Aug 29, 2012 at 17:03
- @Paul: Sorry, I'm not following. What worthwhile document do you think I'm suggesting is bad?pdr– pdr2012-08-29 19:59:46 +00:00Commented Aug 29, 2012 at 19:59
Add a comment |
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
- create code fences with backticks ` or tildes ~ ```
like so
``` - add language identifier to highlight code ```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_` - quote by placing > at start of line
- to make links (use https whenever possible) <https://example.com>[example](https://example.com)<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you