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

Many sections need to be rewritten to be more explanatory ("how") than expository ("what") #16

Closed
CAM-Gerlach opened this issue Apr 1, 2018 · 0 comments

Comments

@CAM-Gerlach
Copy link
Member

Issue Description

In a number of sections of the documentation, various features (e.g. splitting the editor, to name one example) are outlined and their purpose detailed, but there is little to no information about how to actually activate and use them from a technical perspective. Therefore, the documentation as a whole should be re-written where practicable to focus more on explaining the "how", and less on just showcasing the "what", keeping in mind this is supposed to be a technical help manual, not promotional material (like the website).

Where is the relevant portion of the documentation located?

Throughout; the overview is 100% this which isn't entirely bad, but each feature could use at least a brief explanation on how to open/activate/use it; many of the feature sections say what Spyder can do but not how to actually do it as a user.

What would you suggest it be replaced with?

More explanatory, step by step guidance and explanations.

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

No branches or pull requests

1 participant