# What should the FAQ contain?

The mathoverflow site has a great FAQ. What are some key points that the FAQ for this ask.sagemath.org site should make?

What should the FAQ contain?

3

For one, the site should clearly specify its role in providing help for using the Sage software. That is, with the **sage-devel** and **sage-support** Google Groups already in place a good question to ask is whether or not this site should in whole or in part provide programming help. Specifying whether or not to focus on user-level or developer-level comments or even both would also help in answering this questions. On a more practical note, the FAQ could provide links to these two sites and state their purpose.

William Stein mentions in his blog post

"The site would not be specific to Sage or restricted to open source."

So another question to ask is "how is ask.sagemath.org distinct from MathOverflow?" since both focus on mathematics. At the very least, my guess is that the topics would focus around "computational mathematics"; that is, anything that could possibly be implemented in Sage. By no means should the site not allow research-level questions. Including them would be great! The FAQ should make clear whatever distinctions are required.

These are just a few questions that popped up in my head when I found out about this neat question board. I'm interested to hear what other people have to say.

My blog remark was really about a site like mathoverflow focused on computation. I don't think http://ask.sagemath.org is that -- sage is in the name. I also don't think ask.sagemath should be focused on developer questions. It could be: *user question involving sage* -- a better sage-support

But it will be good to watch what happens, and decide later just what ask.sagemath.org should be.

It would be really interesting if some research discussions involving some computational / Sage elements would spawn on ask.sagemath.org! Once my qualifying exams are over and I resume my work on computing Riemann matrices I hope to contribute some discussions of my own.

2

A clear statement that this site is for the *mathematics software* Sage, not the accounting software by the same name.

2

It should have VERY clear instructions about what people can and cannot do with various 'point levels', and exactly how many 'points' you get for various actions. For example, I just wanted to retag a bunch of questions as 'graphics' since that matches the Trac thing and would make them easy to find... but I can't.

There should also be explanations of every color thingie and what the "0 mins ago John Palmieri 36" means (last answer? last comment? what?). Essentially, every possible thing on the front page should be well-documented on the FAQ.

To be fair, I just checked out the actual askbot site... and it doesn't do that either!

(This is less on topic, but it is also weird that the number of votes and answers on the front page don't correspond to the actual number of votes and answers.)

2

**how to ask a good question,** e.g. aim to post a question with code that can reproduce your problem, make it short.

2

The FAQ should say that this site is for questions about using the software, not about answering homework or other general mathematical questions.

Some places to get such help are:

- Dr. Math
- Math Stackexchange
- Ask an Algebraist (for algebra questions)

2

Recently askbot has been updated to make it easy to link to Trac tickets with the syntax "ticket 1956" as well as autolinking url's like http://sagemath.org. Both of these would make useful additions to the FAQ. Further details are given here (at the askbot site)

Moreover, new users often overlook the code formatting button (little picture of 0's and 1's), so perhaps that should be a FAQ item too.

2

Before answering the question "What are some key points that the FAQ for this ask.sagemath.org site should make?", we need to know exactly what this site is for. Do we want questions about how to compute things with Sage or other software? Do we want questions about installing and basic usage of Sage? Do we want questions about design, improvement, bugfixes in Sage?

Having a well-defined focus will certainly improve the usefulness of this site. I would like to see the relationship between this and the mailing lists explained/decided.

We might also develop some guidelines about the questions that are asked. It seems like a question such as "Should we support 32-bit FreeBSD?" would not be ideal for this venue; a question such as "I have a bunch of data in format X, how do I load that into Sage, interpret it as Y, and then compute Z?" seems much better.

Having studied the *overflow sites a lot this week, I think this site is most likely to be of value for answering questions like your last example: "I want to do X using Sage. How?" This will help exactly where sage-support often fails, since questions won't get lost here so easily.

Also, such questions have a fairly definite answer, and these sites work best with questions that have a definite answer.

1

What is this site for?

This probably deserves to be its own question, but some discussion has started in the comments here already. I'd like to add that I think/hope certain questions about sage development can be included here (and tagged with `devel`

)--this could be a good resource for those starting out with sage development. For example, the question about mercurial queues could, in its answers, help others get off to a smoother start.

Explaining good use of tags, in general, is a good idea. The FAQ could suggest / require that certain topics (like sage development) include tags. It might be helpful to use tags to separate the devel and support communities so it's easier to find relevant posts.

1

1

Links to other places for getting help:

- some good intro. to Python tutorials
- Sage Reference Manual
`sage-support`

`sage-devel`

Asked: **
2010-08-18 12:55:17 -0600
**

Seen: **3,246 times**

Last updated: **Nov 02 '16**

What kinds of autolinking are supported by asksage?

Buggy ask.sagemath rss feed in Feedly. How to solve?

What are the 10 most often used functions in Sage?

where is the SageMath "Demonstrations Project"?

Defining custom global constants

Is it possible on ask.sagemath.org to edit other user's questions?

Copyright Sage, 2010. Some rights reserved under creative commons license. Content on this site is licensed under a Creative Commons Attribution Share Alike 3.0 license.

it might be useful to resurrect this question for a while

Question? Does the FAQ include any of these things? Doesn't seem to...

no, I don't know who would update it. Another approach would be to post these as separate question/answer pairs -- I think I'll try that with the syntax question