Edit - Software Engineering Stack Exchange

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.

Thanks, that makes sense. As you suggest, I'm far more interested in quick, brief, "living" info than huge static docs.

Alistair77
– Alistair77

2011-09-01 23:09:35 +00:00
Commented Sep 1, 2011 at 23:09
@Alistair77: Be absolutely sure the developers are perfectly clear on what you need to know. It's easy to ask for too much. You can claim here that you want "quick, brief, "living" info" and still wind up demanding a traditional big-design-up-front kind of document.

S.Lott
– S.Lott

2011-09-02 01:23:36 +00:00
Commented Sep 2, 2011 at 1:23

Add a comment |

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

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>

formatting help »
answering help »