Skip to content

Conversation

SteveDunn
Copy link
Contributor

Summary

Added a note to the page to say that the guidelines are reprinted from a book dated 2008 and may be out of date/superseded.

Fixes #26464

@BillWagner
Copy link
Member

Tagging @tdykstra

What are your thoughts on this change?

@MSDN-WhiteKnight
Copy link
Contributor

If guidelines are outdated, it should be solved in more consistent way. Why should we single out the collections page specifically, if there are pages that are actually more outdated? For example, the Serialization talks about BinaryFormatter and DataContractJsonSerializer, which are no longer recommended for serialization. Also, adding such visible note "guidelines are out of date" on top of the page could make reader think that all guidelines are useless and should not be followed, which is not the case.

Ideally, i'd rather want up-to-date guidelines, instead of outdated guidelines with deprecation notes attached to them. As i understand, the new edition of the book is about to be published: https://www.amazon.com/Framework-Design-Guidelines-Conventions-Addison-Wesley/dp/0135896460/ref=sr_1_2?keywords=Framework+Design+Guidelines&qid=1581295416&sr=8-2 , but will it be possible to publish its contents on Microsoft Docs? It also makes me think, could the Framework Guidelines use the same process as C# standard, when draft version of guidelines is edited in open source repository, and when changes are ready they are published as a book? That way community could suggests changes in that repository, instead of having them constantly shot down in this repository due to copyrighted content.

@BillWagner
Copy link
Member

@MSDN-WhiteKnight Great comment.

We are talking with the publisher to acquire the rights to update this content. That would be the best solution. We haven't finished that work.

@SteveDunn
Copy link
Contributor Author

SteveDunn commented Nov 2, 2021

I really liked the original book (I was a community reviewer for it), but it is focused on designing 'Frameworks' (which is fair enough, that's exactly what it says on the tin!). But users are blindly applying some of the guidelines to applications, where they make less sense. I haven't got a definitive list of such guidelines, but I'll try to get a list together, maybe in a blog post at https://blog.dunnhq.com

@SteveDunn
Copy link
Contributor Author

Perhaps all the CA warnings could be grouped by 'applicability', e.g. applicable to a 'reusable library of framework', or applicable to 'a non reusable application (console/webapi etc.)'

@BillWagner BillWagner modified the milestones: October 2021, December 2021 Dec 3, 2021
@IEvangelist IEvangelist added the framework-design/guidelines Issues relates to the 2008 framework design guidelines. label Dec 10, 2021
@BillWagner
Copy link
Member

Hi 👋 @SteveDunn

We're archiving this content until we work with the authors and publishers to acquire permission to the latest version. See #27495

Because of that, I'll close this PR.

@BillWagner BillWagner closed this Dec 10, 2021
@SteveDunn
Copy link
Contributor Author

Hi 👋 @SteveDunn

We're archiving this content until we work with the authors and publishers to acquire permission to the latest version. See #27495

Because of that, I'll close this PR.

OK @BillWagner - thanks for the update

@SteveDunn
Copy link
Contributor Author

If guidelines are outdated, it should be solved in more consistent way. Why should we single out the collections page specifically, if there are pages that are actually more outdated? For example, the Serialization talks about BinaryFormatter and DataContractJsonSerializer, which are no longer recommended for serialization. Also, adding such visible note "guidelines are out of date" on top of the page could make reader think that all guidelines are useless and should not be followed, which is not the case.

Ideally, i'd rather want up-to-date guidelines, instead of outdated guidelines with deprecation notes attached to them. As i understand, the new edition of the book is about to be published: https://www.amazon.com/Framework-Design-Guidelines-Conventions-Addison-Wesley/dp/0135896460/ref=sr_1_2?keywords=Framework+Design+Guidelines&qid=1581295416&sr=8-2 , but will it be possible to publish its contents on Microsoft Docs? It also makes me think, could the Framework Guidelines use the same process as C# standard, when draft version of guidelines is edited in open source repository, and when changes are ready they are published as a book? That way community could suggests changes in that repository, instead of having them constantly shot down in this repository due to copyrighted content.

The publish date for the 3rd Edition says June '2020. I can still see the collections guidance is still live though (just had someone reference it my team)

@SteveDunn
Copy link
Contributor Author

Hi 👋 @SteveDunn

We're archiving this content until we work with the authors and publishers to acquire permission to the latest version. See #27495

Because of that, I'll close this PR.

Hi @BillWagner - I can still see that it's live. In discussion with team members, this page is still getting quoted as best-practice. https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/guidelines-for-collections?source=docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is the Collections guidelines page out of date?
5 participants