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

Update documentation to reflect present tense #370

Open
ArchitectedDev opened this issue Jan 6, 2022 · 0 comments
Open

Update documentation to reflect present tense #370

ArchitectedDev opened this issue Jan 6, 2022 · 0 comments

Comments

@ArchitectedDev
Copy link
Contributor

TLDR; Knowledge-base articles should be current and relevant?

An observation from reviewing many knowledge-base articles is that there is a lot of talk about new and upcoming features. Articles can date back a number of years and lead to questions as to whether they are up-to-date and still relevant.

My suggestion here is that by updating articles where applicable to speak in the present tense we can give the impression that the articles are being maintained and are always current. This also cuts the fat around how functionality previously behaved or lengthy introductions of what is going to be released. Introducing Premium Search, which seems like it may have been migrated from a blog post.

If needed, we could also add caveats to flag changes in previous behaviour and when they were changed, however this could be addressed as they come up.

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

No branches or pull requests

1 participant