Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a package design vignette #69

Closed
pratikunterwegs opened this issue Jul 14, 2023 · 2 comments · Fixed by #188
Closed

Add a package design vignette #69

pratikunterwegs opened this issue Jul 14, 2023 · 2 comments · Fixed by #188
Assignees
Labels
Discussion Issues kept open for discussions in the comments Documentation Improvements or additions to documentation

Comments

@pratikunterwegs
Copy link
Collaborator

This issue is to request the addition of a package design document as a vignette. This will serve as a trial and potential template for additional design documents for other packages.

@pratikunterwegs pratikunterwegs self-assigned this Jul 14, 2023
@pratikunterwegs pratikunterwegs added Documentation Improvements or additions to documentation Discussion Issues kept open for discussions in the comments labels Jul 14, 2023
@avallecam
Copy link
Member

avallecam commented Jul 24, 2023

Is there space for some personas as target users' profiles? I'd like to test if may be helpful or informative for defining or delimiting some negotiable or non-negotiable package design principles. If not for this package, possibly for the next one.

@pratikunterwegs
Copy link
Collaborator Author

Thanks @avallecam - we do have a section in the draft template for the use case, which includes a brief description of the target users. We could add a note that package authors could reference some of the personas if they feel they are useful. Ideally though, the documents would be stand-alone, so not requiring much reference externally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Issues kept open for discussions in the comments Documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants