Non Agile Technical Roles

[LondonManc]

WHS. "Just enough documentation" applies to comments too. The problem is when people think they should do comments you end up with "++x; // increment x", which is just a waste of bytes.

Agreed.

For stored procedures, I'd start with a comments summary at the top - including a who touched it last comment. While that should all be in your version management software, it's amazing how undisciplined some people are. Well, it's not amazing, it's more that they're inexperienced, lazy, clueless, cheap chunts.

Then there's a summary of what the script does and anything non-standard in there.

[ChrisFromGreece]

That explains everything....

and partly Agile Coach

[LondonManc]

Technical Architect

Ah, I've seen these people. They're very good at reinventing the wheel.

[eek]

and partly Agile Coach

And there's all the confirmation I need...

[ChrisFromGreece]

And there's all the confirmation I need...

Ermmm... ok!

[DimPrawn]

Comments should include things like design decisions - while any SQL developer worth their salt should be able to understand what it does, it's important to know why it's doing it. If there's minimal documentation barring a user story on a board that simply talks about what should be done, you're leaving yourself wide open.

Client didn't like that answer. Why are design decisions being reflected in code comments? These decisions should be documented in the design.

Implementation choices should be obvious from the code.

Therefore zero comments, or else the code will fail the review process.

Bare in mind the team were all straight from Uni, trained in Agile only.

[bobspud]

It's not on mine and nor will it ever be!

Don't say never. It can work well when not run by an utter bell end

Infact done well it looks a lot like well planned out Waterfall

[LondonManc]

Client didn't like that answer. Why are design decisions being reflected in code comments? These decisions should be documented in the design.

Implementation choices should be obvious from the code.

Therefore zero comments, or else the code will fail the review process.

Bare in mind the team were all straight from Uni, trained in Agile only.

That's wonderful. Now where's the design document?

But we don't need it, we're agile....

Rinse and repeat.

[VillageContractor]

That's wonderful. Now where's the design document?

But we don't need it, we're agile....

Rinse and repeat.

Agile doesn't mean no documentation. People use agile as an excuse to not do documentation

[DimPrawn]

Agile doesn't mean no documentation. People use agile as an excuse to not do documentation

We had a "living" design documented on Confluence with issues and tasks linked in JIRA.