Speech Transcript - Documentation: state of the union

0:00:09	i'm getting the feeling that have documentation it team is actually in this room right
0:00:13	now
0:00:17	so the docking station team has excess this for almost as long as the name
0:00:21	project
0:00:22	came around and i know it's not with they may snow who were inspired by
0:00:27	the red hat labs to write the contention for them
0:00:31	and i turned out to be he happened to be really good that
0:00:36	and manage the process knowledge onto the rest of the community and that's how we
0:00:40	ended up with a docking station team in the first place
0:00:43	the month was passed from person to person for few years and eventually shown what
0:00:48	can send that out
0:00:49	dictator and two thousand three and this year will be his tenth anniversary of the
0:00:55	september
0:00:57	and eventually we came to name three but that a definite i think three has
0:01:01	a question
0:01:05	sean has millions
0:01:07	and some of them are actually here
0:01:09	thank you got millions and he makes good use of us people so it's around
0:01:13	all the time
0:01:16	who are the contention team well
0:01:19	we don't really have a
0:01:23	i know
0:01:25	E to do something about that
0:01:27	it's not enough
0:01:33	are you going to submit a patch
0:01:36	today
0:01:40	one
0:01:43	was a committed
0:01:47	okay well that i forgot that france the first time
0:01:50	i was just think that from memory and there are actually we have about
0:01:55	fifty applications that we maintain documentation for on the top of that we have developer
0:02:01	documentation the system administrator guys at actually no single person can really keep track of
0:02:07	all of that which is probably why i missed your patch
0:02:10	and we don't have a formal team structure we have shown results
0:02:16	and then we have all of us to do all the work
0:02:19	and the we have members who are native english speakers we have people who are
0:02:25	not everyone has something to contributes we have over the last year we had twenty
0:02:31	five notable contributors
0:02:34	seven of whom made significant contributions to lots and lots of projects
0:02:41	we have
0:02:44	we actually take most of intense for that speech program we have five mentors for
0:02:49	willing to mentor intense cordless on the name of page we actually taken things outside
0:02:55	of the program as well but is less formally so
0:02:59	and that was four years we actually have twelve intense for whom i with us
0:03:03	today in this room and up
0:03:07	there we go for
0:03:09	and six of us and now foundation numbers which i think is actually pretty successful
0:03:14	i think we've done really well
0:03:22	so we're as we came along we decided welsh on the slide that side he
0:03:28	wanted to improve the user documentation and experience for users
0:03:33	so previously i can and two minutes of the help was written in top or
0:03:38	which is really good for developer help but not actually so good for user help
0:03:42	because the first thing you see when you look at the dot book how a
0:03:48	double help is just a blank page with an index
0:03:52	that's not really very useful
0:03:54	i don't help was also written and the hierarchical
0:03:59	a structural and focus on
0:04:03	describing the user interface
0:04:06	and actually who wants to read through a description of the user interface to find
0:04:10	out how to achieve some
0:04:12	and you want
0:04:14	okay the lakers
0:04:16	so
0:04:17	with names three because the user interface change too much between them two and three
0:04:21	and also may of applications change we choose to rewrite the hell in model at
0:04:27	which was which is next the mel languages which was designed by sean specifically for
0:04:33	user help
0:04:34	it when you look a lot of help i mean you will to talk will
0:04:37	help it looks very different
0:04:38	it's much more task oriented
0:04:41	so wanna use a reason to help they
0:04:44	generally have like they have something they want to achieve
0:04:48	they look at the user help and they find how to achieve that so instructions
0:04:51	how to achieve something rather than
0:04:54	have the user interface
0:04:57	and thus as i mentioned this to we have a team members from all over
0:05:01	the world we tend to write in simple english because firstly it's easier to translate
0:05:06	saintly and you want all or nothing you want but may people find it much
0:05:10	easier to write and actually many people find it much easier to understand as well
0:05:15	and as it turns out it's pretty important because actually user help is not translated
0:05:20	very well i we don't have very many translations as you can see from them
0:05:25	to name three there has not been much change
0:05:29	most of the user hell translations so it's under ten percent translate that i'm sorry
0:05:36	most languages the user help is translate the on the simpsons we use help translate
0:05:40	that we have had only one language consistently translated to be nine percent if i'd
0:05:46	almost a hundred percent at every release and that the spanish
0:05:50	so we really appreciate that
0:05:53	and would be great if we can somehow encouraged translators to
0:05:57	actually translate the user
0:05:59	i'll tell you why that's important and that's
0:06:04	so our users we
0:06:06	have a lot of users gently they're not people who are sitting in this room
0:06:10	that help is designed for people who actually don't know how to use application at
0:06:15	all
0:06:16	all people who have used for many years
0:06:19	and we still get it's all useful for people who are here for example if
0:06:23	the user interface changes and something you can find some
0:06:27	"'cause" the user help well that you will find out that or maybe it's a
0:06:31	speech which has been
0:06:33	okay i have everything
0:06:35	so we can't actually track
0:06:38	who reads the desktop help which are construct who reads what they find useful what
0:06:44	they didn't find useful
0:06:46	the best reviews we gets are actually from translators because they often file bugs within
0:06:54	seven days of documents
0:06:57	so which is really high because that's long before release usually so we can actually
0:07:02	fix things i mean within the team we have a review process as well where
0:07:06	in the hell will normally be reviewed by three different people
0:07:11	on the other hand users germany and get the runt reporting box six months after
0:07:16	the release which can be up to a year after the page was right
0:07:21	and this means that so very often by the time they report the but either
0:07:26	the U I has changed an application the help as being very rewritten
0:07:30	or the problem has already been fixed
0:07:34	and if it's and mastery germany but sometimes
0:07:39	they might not actually be able to get the fixed without suppression
0:07:42	if they might have to actually with another six months to see the fix
0:07:46	which isn't very user friendly
0:07:49	thanks to hundred every we have actually recently being able to try are uses on
0:07:55	like we don't know about or which has proven to be really handy
0:07:59	as you can see a it's a particularly good so i've got but you can
0:08:03	see the trends and so what that shows
0:08:06	is the blue line is unique that's
0:08:10	the magenta is unique page fees and the yellow is all each fees on average
0:08:15	we get approximately six thousand unique page views a date which is much more than
0:08:20	many of the other and then website this by the way covers a user hell
0:08:25	and developer help and the system administrator guide
0:08:29	and as you can see the trend shows that so
0:08:33	we have the most page views on weekdays and that implies that so many of
0:08:40	our users for beating the websites are doing so at or rather than
0:08:45	which is quite surprising i was actually expecting for most of our users to be
0:08:49	using to be reading the help
0:08:51	but that's not the case
0:08:58	yes when there's nothing on T V
0:09:00	and actually along with that's what we found was that the spanish translations all the
0:09:07	user help i've been bred much more often than the ritual use help and this
0:09:12	is why translations are importance
0:09:15	eight out of the top ten read pay most read pages between the user help
0:09:20	and the developer documentation happiness five
0:09:25	a forced now she's is
0:09:29	so that if you pay a few waste that
0:09:33	developers and designers can actually help us improve the help before the release
0:09:39	because of course we always want to provide the best hope that we can for
0:09:42	users
0:09:44	so for example designer a applications gonna have tool tips because
0:09:51	a button does hasn't in icon so know text
0:09:55	then it's very difficult for us to describe
0:09:59	and we also need to talk about how to interact with the user interface and
0:10:04	will help of design is actually try to top themselves through is as well because
0:10:09	if they're not able to describe how user should be interacting with a specific button
0:10:13	or label then we probably quantity there
0:10:17	so you know they can come talk us or even just come up with a
0:10:20	way to describe it themselves
0:10:22	and i will help us quite a lot
0:10:26	and as for developers and
0:10:29	we do try to keep on top of user help on them and time and
0:10:34	have it done time for the releases
0:10:36	but sometimes you know we don't know about the changes
0:10:40	or
0:10:41	we can't actually test the latest application easily so we might need help just building
0:10:46	it even
0:10:47	so that we can see the what it should look like and whether they have
0:10:51	been any changes so please file bugs against the have dogs
0:10:55	well then when there you i changes problem when there
0:10:59	the application starts working differently when the user get something back from application that is
0:11:05	not what they used to get
0:11:06	so that we can update the help
0:11:09	and of course there are some applications which don't this the their shoulder functionality to
0:11:13	the user through the user interface X for example there sometimes hidden shortcuts which are
0:11:18	mentioned anywhere
0:11:20	but still also not good there so it was really help if when your body's
0:11:25	so when we were documenting application just come talk to us
0:11:28	tell us what we should be looking at
0:11:31	that really helps
0:11:33	of course as we document your application we will do a full user in a
0:11:38	your i review and usability testing we will actually go for your application
0:11:45	and we will try to use it as we normally what i tried to use
0:11:49	of how other people like you said
0:11:51	and the average we find
0:11:54	ten or twenty bucks and they application give application what we do that even if
0:11:59	nothing has changed in a few months
0:12:02	so we will tested for you said do last customer help for it
0:12:10	so the moments we are working on developer documentation and the platform overview effort is
0:12:16	being but by for the tickle who is over here
0:12:19	make sure gonna see
0:12:25	it's a an area which has been neglected someone and this
0:12:29	desperately need of more work
0:12:32	we are restructuring the platform overview almost from scratch
0:12:38	have we have new review pages and we will be integrating some of the developer
0:12:44	documentation into it
0:12:47	so we always we always need help with that so if you have to help
0:12:51	that's just come find that's where having it at a
0:12:54	i have has so on a for the help so we have implementation i sorry
0:12:59	about the documentation that we're have this for next week and also the system administrator
0:13:03	guide the guy the system illustrated right hasn't had much love sense
0:13:10	before and it three
0:13:12	so well to have our system administrators would want to
0:13:17	manage their users has changed and the at the moment there is very little documentation
0:13:23	about this
0:13:24	there's something a few things on the we key
0:13:27	so that's what the other every at that were currently focusing on and that there
0:13:32	and there are who's doing that there are helping out with that
0:13:37	huh
0:13:39	and also we have been so busy making sure that all the application help as
0:13:45	up to date that we have slightly neglected our startup guide
0:13:48	the sell that this document which basically
0:13:52	helps a newcomers to the docking station team learn how to
0:13:57	right the hell which turned to use which vocabulary to use
0:14:02	and grammar
0:14:03	and turns
0:14:05	all sorts but that's been a bit neglected because we in concentration on the user
0:14:10	help so that something about we would like to get on some time soon as
0:14:14	we are
0:14:15	all those the almost then we have or specially writing these are help all of
0:14:20	these are hope and mallard and almost all that's up to date now
0:14:24	it's actually gotten to the point where it's quite difficult to find you projects for
0:14:29	instance two documents
0:14:31	so when i'm with you want to make sense from nothing to P
0:14:35	just like to say a big thank you to brian and rate who have provided
0:14:40	us with a lot of help and tech support when it came to the system
0:14:43	administrator's guide
0:14:45	they're the people who wrote the tools so we want the last for the help
0:14:48	and they have been very receptive
0:14:51	give us a lot of advice
0:14:53	and that means that we've actually what we have pretty so far as accurate precise
0:14:58	and it's easy to understand
0:15:02	a question has proven to be a very basically the best developer to work with
0:15:08	a typical what cindy here has support will start talking to him
0:15:13	as she was writing the user help for the terminal
0:15:16	and he was very receptive to improving the U R E and the
0:15:23	basically he provided support when we do that and what station with of the top
0:15:28	that's
0:15:29	they has been very helpful that's a writing tech support that are happens
0:15:35	which we have needed at the last happens we had
0:15:38	three out of about eight laptops die on of
0:15:41	in the first day
0:15:43	that was fun
0:15:46	under
0:15:48	i that
0:15:50	he's also be very patient with our intense and sneak comments as being great yes
0:15:56	you have
0:15:58	there are beyond a
0:16:02	and same for a them adam has
0:16:04	actually gone so far as to what for instance through submitting there will potential entrants
0:16:10	for that speech problem three submitting the first batches
0:16:13	and debugging their problems when trying to build applications that takes a lot of dedication
0:16:21	so a big thank you to adam as well
0:16:24	so having a few more talks at one thing about the conditions there is one
0:16:28	later today i about by getting started videos which are what you see the first
0:16:34	time you want to your user account your name user account
0:16:38	so he's giving a presentation at six P M today
0:16:42	i like i like talk i think and the pattern twisting right there
0:16:48	it's going to be talking about what we've been doing with the developer documentation over
0:16:52	the last two years market was an outreach program that one well you started you
0:16:58	have your associates last year
0:17:00	but that covers what is a tiffany started on before that
0:17:05	and that's will eventually be integrated with the classroom overview which for that includes working
0:17:09	on so martin stop it's the more at four if you're interested sorry that to
0:17:14	them are to in this room if you're interested and developer documentation do problem that's
0:17:19	what she has to say and then join us for the developer documentation had this
0:17:24	next week
0:17:26	so we're having a developer documentation well i'm sorry hard as for the whole week
0:17:31	and we're also having a system administrator's guide had this for the whole week and
0:17:35	all that we got the both with some international is a dish of people from
0:17:40	that centralisation team will help us i hope make it's easier to write tell
0:17:45	for translators well make it easier for translations to translate that help
0:17:52	so that's i think that's all i've got to say for the last year
0:17:55	you know the question i don't people have lots of questions
0:17:59	awesome
0:18:03	no use also to you want you know if you know use you should also
0:18:13	i think that there are some companies that are using it instead of the
0:18:19	but there aren't any major use out of it outside
0:18:23	we have well she'll have spoken to katie to see they would use
0:18:30	what if you could write something similar to yell it for them to use and
0:18:34	for them to use my lights a friendly lot of the data help but i
0:18:39	just five minutes i think i'm thinking
0:18:44	so i have a question after every release
0:18:51	what sort of testing goes like remote versus the tutorials and things like that make
0:18:56	sure that
0:18:57	they still work against
0:19:00	this is that don
0:19:02	prior to release or i mean we try to do all testing before the release
0:19:09	but what if like me and i stuff so we are actually
0:19:13	we didn't get the developer documentation testing done
0:19:16	because we don't have that people to do that
0:19:19	that's why save anyone's interest and all the documentation we really very needy
0:19:23	so if i can help you with that
0:19:26	i have
0:19:30	i think this is some sort of this is a function of
0:19:35	outreach your marketing team in which we can ask you can mediate march two
0:19:40	i can people do that especially things like tutorials work that can that can easily
0:19:45	be done
0:19:48	the one is that you have to have image
0:19:51	that we there could do test so that we can that least even or something
0:19:56	provides an image
0:19:58	prior to release
0:20:00	and then
0:20:03	actually so i would be really great if you could that once that actually happens
0:20:07	and as far as i understand austria will help us actually do that that's thing
0:20:12	once that what's because more mature and that's true for translations to translated
0:20:20	documentation
0:20:22	i think we buy documentation all the go always we don't have documentation freezes because
0:20:27	we don't have enough people to actually be able to finish it sometime for free
0:20:31	we might be for the could mean we might be a good
0:20:35	so i thought should indicate how much spare time we have for testing
0:20:39	but we do try to test and we do make sure that's what we actually
0:20:42	might we get for if you saw problem within the team and of course if
0:20:46	anyone else falls about we always say patches welcome if you want to help us
0:20:50	what we fix it
0:20:52	okay all right so i'll so we do it
0:20:57	thanks for helping
0:21:04	have like here
0:21:10	i so you mention that so you have interns to do documentation i guess that
0:21:17	is problem with documentation as much as with many other non cutting tasks the if
0:21:21	you want to be sponsors low paid over there you want to call it to
0:21:25	do any of this work the average for women is really the only thing that's
0:21:29	available do you see that changing going for those of any chance of some money
0:21:34	from elsewhere to get people plates right augmentation to be on is probably not because
0:21:40	most people don't seem to care about age
0:21:43	it's anything users that you
0:21:46	we have another marketing i think
0:21:51	i mean it would be
0:21:52	i added that most of i need like and the dock station team has been
0:21:56	found outreach program and half of our team it's female happens now which is very
0:22:01	usual for and i suppose project
0:22:04	have we have actually had who knew man train it is anything
0:22:10	i think that i think it's becoming very out features and it and i would
0:22:15	actually love to see new members join for not
0:22:22	i think that bring a lot
0:22:26	so about the fact that we say is that a lot of people do
0:22:33	think documentation is important
0:22:36	so from my perspective documentation is right now
0:22:42	my number one focus i
0:22:45	so
0:22:47	comes out of this if you are trying to learn the platform are trying to
0:22:54	try to
0:22:56	do the code samples or things like that
0:22:59	the documentation is this your only guide to actually writing and now
0:23:06	and if you don't have to a let me give you an example so if
0:23:10	you want to write a java script that
0:23:12	everything is we have is just
0:23:15	generated by you know G T K to or you know five O G attic
0:23:21	introspection
0:23:23	we don't if you don't there there's no context and start which you have nothing
0:23:27	that says this is how you're right one in java script from you need a
0:23:32	loop you know that you need to do they need to do that that's
0:23:36	part of java script so if you're we can warrior and you only have time
0:23:41	to do it like myself they're gonna be very frustrated very quickly
0:23:46	and how we get pumped by other everybody else because are documentation is poor and
0:23:55	we're expected to read the code i don't i don't want to read
0:24:00	i wanna see documentation
0:24:02	we also need more people we just want people to like that made one developers
0:24:06	who are willing to write that station or just people but it's not good
0:24:11	so for me as a brand
0:24:13	it affects the right
0:24:15	so and that's how i look at
0:24:19	i happens that that's the number of people who have been looking for documentation well
0:24:24	what occupation right and their application
0:24:27	i have actually just coupled for and they found out there helpless way which isn't
0:24:32	ideal we of course always you want to provide documentation
0:24:36	but unless we actually have more manpower to do it i don't think it who
0:24:41	is like we do have me back to see if there is obviously working on
0:24:44	the development innovation we've done some what we have a have a lot more
0:24:48	where we are finished
0:24:52	first you know the structure of structural thing you about the documentation we just need
0:24:57	for
0:24:59	they
0:25:04	okay
0:25:05	she's
0:25:08	where is
0:25:09	the
0:25:10	still when i was doing the outreach program from and a internship i fell a
0:25:16	lack of documentation to do right documentation that's what the style guide this for still
0:25:22	i so i dutifully went and looked up the style i like to write out
0:25:26	of print and you know slapped on it but i don't at and i didn't
0:25:32	hear commence interviews that is outdated and so you have in place a style guide
0:25:39	that you recommend to read and it is outdated so my question is why are
0:25:44	two guys working here
0:25:48	because we've got too much today
0:25:51	what i don't know hire right now we had solved on the last year
0:25:56	and then we don't have anyone interested enough to do it i was actually going
0:26:00	to right that's myself
0:26:02	four months ago i think but then some other projects came up and i but
0:26:07	i hope for the since that so for example i chose to write that this
0:26:10	me helps the writing style guide
0:26:12	it's just that
0:26:13	we don't as i each individual the T basically a team works as individuals rather
0:26:19	than the whole team unless where it had passed in which case we just put
0:26:23	all are written to one thing and we go out that i will get done
0:26:28	is jennings and to work on what interests ourselves
0:26:32	rather than what
0:26:34	interest what specific people might want it was we take requests and that's why we
0:26:40	fix but we still say twelve about we will fix them
0:26:45	still the cheapest i described widgets right me basically how you can what object is
0:26:51	and how you describe it in your documentation and seems with a the release of
0:26:56	G D get to be in you know on the applications using a the new
0:27:01	G T K tree lot so we just have changed and those do you don't
0:27:04	need a you know a G D B which is not right and she and
0:27:09	how are newcomers to see educations only great and you get supposed to describe this
0:27:15	generally we recommend that they be at the moment like i just finished that if
0:27:19	you know and we recommend that they be that if you know because that's actually
0:27:22	a good example what help should like
0:27:25	and describe based on that but there's where using for them three applications are still
0:27:29	somewhat flocks
0:27:31	for example empathy was are flagship document the project
0:27:36	three years ago now that is somewhat outdated because we have actually able are the
0:27:42	style of motivation has a fall down through this i think it has improve we
0:27:47	had fewer what we took into account the feedback from users based on what they
0:27:53	found confusing and so i would and that will keep evolving process evolving for some
0:27:58	time to come
0:28:00	but it's at the moment we on our project patient the what can we say
0:28:05	which is our application to look at four
0:28:09	and user help
0:28:11	for developer documentation we don't have a specific style guide at all
0:28:16	because that is still being developed
0:28:21	and the if you actually go read was already there but that's not to the
0:28:25	full
0:28:26	so i've just one ones so
0:28:29	at the data that a still by the time for women and when i it
0:28:36	you have a language that is why it's not you know what is going on
0:28:39	with the documentation team and what is a place that i list doesn't have any
0:28:44	of this stuff that you're working on i mean you know what is propose the
0:28:47	system admin guy that the guy and usually there's you could very a quest for
0:28:52	the system administrator right there is a purpose for that well right there are a
0:28:55	separate pages from the application help there
0:28:58	three cost less and then there are links to sell it to the documentation could
0:29:03	perhaps that G D V saturday included in the tasks for the thousand the page
0:29:08	it okay cool i'll
0:29:26	okay so two things one sort of report to your home
0:29:33	and one about trees
0:29:38	so it's not the
0:29:41	it's just something to help your rights documentation
0:29:44	if you use emacs
0:29:47	emacs is really good for everything X M L based
0:29:51	documentation
0:29:52	and i started a little project called you know emacs you kills
0:29:56	it's my blog
0:29:58	it's basically you download at it's model
0:30:02	you are installed you tell emacs about it
0:30:05	has a condition have to do that
0:30:07	i mean what it does is basically every time you open a model are documents
0:30:12	in emacs
0:30:13	it's kind of the model are X M L schema
0:30:16	and you have tab completion for the available tax at any point in
0:30:21	in your document so you know if you are inside of that patience have a
0:30:27	section inside of
0:30:29	paragraph people tell you a key right here you can put you know
0:30:33	all emphases or a reference to another thing more linked another it is very nice
0:30:39	it's very useful
0:30:56	so we need style but we definitely nist i would i
0:31:01	well you know when i started writing documentation a
0:31:06	that was when we used a cool and the hope is this immense ocean of
0:31:11	tax
0:31:13	and
0:31:14	emacs really help me there at least you know what i could do at any
0:31:18	point in time or at any point in the document
0:31:21	and you know i had
0:31:24	for that specific case you know that will pass
0:31:27	like i don't know nine different types of lists
0:31:31	one aside my fleece order these variable least
0:31:35	list of
0:31:37	this and that kind of thing and even if you get it wrong the first
0:31:41	time
0:31:42	once you have the content in their it is really easy to change the least
0:31:46	i and the sub element types to something else
0:31:49	you know so
0:31:52	don't be afraid of using the wrong elements type because someone later look at it
0:31:57	and say you know you should be using this one instead and it's really change
0:32:00	but it's getting the content written but these hard part
0:32:04	just in response to send it's actually very similar with my learns you have for
0:32:09	example steps for lists which i think steps and the lists we just for the
0:32:15	list of items terms for the vision turns
0:32:19	and that's what's in a similar way
0:32:21	and the point the whole point so well how to hold a part of the
0:32:24	point of using mallard was the tax should be relatively self expiring three
0:32:30	so as you type it as you write something you should be based on to
0:32:35	get some steps and get some steps and steps why want to show an example
0:32:40	and then you just use an example tag
0:32:47	and this is all fine i mean but that's not personally not only concern what
0:32:53	i'm saying it's a i I G some kinder now and i am i've done
0:32:59	some small features for this that gets clients "'cause" but and down they are they're
0:33:06	using a lot of me which it some G T K tree and i had
0:33:09	that i never seen them before i mean these they're very new show there is
0:33:13	like G D G T K had of are now i have for someone who
0:33:17	is waiting documentation for this like let's look let's go back and look from and
0:33:21	you'll be point of view of how will how will they describe our how will
0:33:25	they know what's ahead of our do they maybe that person thinks okay this is
0:33:29	the top but are is not think of the same thing i had to the
0:33:33	developer documentation actually requires prior there is that we have it you have to know
0:33:38	what you're describing
0:33:40	so you have to actually develop the call that were or what about right you
0:33:46	should vision for you
0:33:48	i mean you really so that's where most are still have a little overview a
0:33:54	whole different parts from this
0:33:57	thank you or would have time to recruit these or
0:34:02	both kinds of things and then we can start looking for from that we get
0:34:06	this is a some advices ripping right there is a cell phones and also and
0:34:11	they what's to say something so file i guess say what's missing something also start
0:34:18	let's about is it is a problem recently if you're interested will actually go for
0:34:23	the presentation about something you would sort of in detail but reputations and of course
0:34:29	all these things which recovering so if you could to discuss redevelopment vision that which
0:34:33	recovery you will see this thing so that even visually created an idea some of
0:34:37	the new features that you might want to be looking at but at some things
0:34:41	that you know somebody we started documentation now we don't know the documentation is supposed
0:34:45	to be we have low entry barrier and you're taking people who don't have a
0:34:50	fourteen experience so it's like a chicken any problem you want to know that of
0:34:54	the documentation exist that these are like really new people so they don't hope for
0:34:59	salvation is not really intended for self is that you maybe you have to know
0:35:03	what they're doing show it is it is a requirement that you need to specify
0:35:07	probably a on the page before you know people line
0:35:12	we have people contributing not very good outreach program and we actually there is
0:35:19	really have very many what with this year we have a have a and that's
0:35:22	what about the documentation we had that we currently out there for the user helping
0:35:26	you to use a help as well last year we had four and there is
0:35:30	for developer documentation they to start from scratch so i think it's to them along
0:35:35	a lot of time to get up to speed
0:35:37	i have martin can probably say something about that if some parts her microphone
0:35:59	i am working i'm trying to work on that
0:36:05	on something that you might like
0:36:08	it's the it's a
0:36:11	you something can there is the door you know
0:36:14	so far it's just for
0:36:16	dig a
0:36:18	i would like
0:36:20	to have something like that to for other libraries the i'm working on the one
0:36:26	for by then
0:36:28	mad for the market is upstairs because we i might for the is working on
0:36:36	something similar for javascript
0:36:41	and actually my talk tomorrow about this project
0:36:46	so i are you getting to be talking about how you actually started right to
0:36:49	help us and you come right yes
0:36:51	issue becoming
0:36:54	that's good that's good for me irina
0:36:57	and i think sites also have on site
0:37:01	okay
0:37:05	i just i something what's in the say as and things that need of more
0:37:10	documentation on the B P a one of things that i have some but depending
0:37:14	on but then one of these is to do with experiments you i am hoping
0:37:17	that should i wouldn't want in here don't getting that we use because i as
0:37:22	well you know some stuff one experiment you i interviewed use but i think it's
0:37:26	more to do it the fact that they're not
0:37:30	i don't we're going to be because i had like use experiment us but mine
0:37:36	as for one of the but then it still don't know how to
0:37:39	and i
0:37:40	couldn't really find documented and you know stuff on the big on this or maybe
0:37:44	i haven't been can probably
0:37:46	well
0:37:48	if it's not there
0:37:50	thank you can out that
0:37:52	it should actually right that the patient i'm you know i'm just seen that i
0:37:56	might don't know how to experiment un
0:38:00	in i okay so for start but it's not that we key we did not
0:38:06	have any documentation about that
0:38:09	the location for that is on the project about website
0:38:14	and there is some degradation about that but it's still
0:38:18	okay by than a space it's really as experimental we don't know which way will
0:38:22	get better does a lot of work with that
0:38:24	so personally i find of the best thing to do is actually look at examples
0:38:28	of that this work
0:38:29	different how to use it
0:38:31	i think it does but have you have anything to say that's about
0:38:37	so
0:38:39	but it's sure it's
0:38:41	course for books about most experiments this is
0:38:48	and all that this implement that we will go or it's a moving target also
0:38:53	changing we maybe have also you know sledge my lower the biggest visual know ricky
0:39:02	which are realists
0:39:05	men's from the experiment on them snakes basis that i want to implement the you
0:39:09	know
0:39:10	so that's probably the only resource new one more workable
0:39:23	we have us
0:39:25	just a quick comments
0:39:29	what on one know the your slides there is a library but know that and
0:39:33	i think it changed to help that know that all know that is actually not
0:39:38	the case lightly cover is held about sitting
0:39:45	so when you get like we the first thing you see is a user is
0:39:50	developers system straight i want to actually click on this is will take the something
0:39:57	but actually like that what websites we get from that covers all of have to
0:40:02	use it developer and this is a straight guy
0:40:07	we have some time for some more questions anybody
0:40:15	so that so i mean we king mo P flow
0:40:22	what's your strategy for the next so i don't know speaks
0:40:27	something like that and it does seem like a lot of stuff found
0:40:34	it's not clear
0:40:38	to me and what is most important to be like
0:40:44	we do not have a very diverse team and as i was saying most of
0:40:48	us prefer to work on user help because that's a lot of about to have
0:40:53	very few developers and the documentation team which has proven to be a problem
0:40:58	but generally people working there is that they're interested because that's where they must matrix
0:41:03	to work
0:41:04	so i hope so for most the contributors i expect will be working on maintaining
0:41:12	the user help for they could is leading that right for the developer hell
0:41:18	that that's our entire happy working on the system administrator but i plan to continue
0:41:22	working on that
0:41:24	we have brian voices well who has been working who has started that how do
0:41:30	i series of the week E and all that's actually just one of these different
0:41:34	things if we were to constraint on one for start it would not be good
0:41:37	use of our time because some of us do not are not very good in
0:41:41	that area
0:41:42	of course we can amend have to but that would just me that we would
0:41:46	have to give up working in other areas to be able to achieve
0:41:50	okay so no my question online and so
0:41:57	what's your strategy and for the better no what's your strategy D to have like
0:42:03	a set a so plan come a because it i
0:42:09	if it can be difficult i think for people to you can vote still didn't
0:42:14	know
0:42:15	you know how to how to style and
0:42:21	i think
0:42:23	i think
0:42:27	i this is all the goal currently for the developer who is to finish then
0:42:34	you buy from a fee which the go for developer help is to finish the
0:42:39	platform of review which is which is and gets so anyone can go look that
0:42:46	where we are i thing you descriptions for various areas of about form
0:42:52	i swear moving the we're moving the that is that's what has be working on
0:42:59	into that
0:43:01	i once that's complete that will be development or
0:43:05	so where overhauling about from scratch
0:43:09	we have
0:43:11	i know
0:43:15	for the user how it's now getting to the point where it's primarily made sense
0:43:20	if you go on to our we key
0:43:23	which you will find so we got a little functions documentation project
0:43:30	and that youtube application helped us page you will see all the application help supplement
0:43:36	english that there
0:43:38	and it actually has individual states this
0:43:42	our aim is to get all of the states as into green which is complete
0:43:47	done for if you
0:43:48	and ready to be shipped
0:43:50	and that is basically are ongoing maintenance we have i mean this now finishing the
0:43:56	last
0:43:57	all day user help which experience of from the top block as far protection
0:44:15	any other questions
0:44:18	i think we can take another question anybody
0:44:22	is just a couple of minutes left
0:44:31	okay thank you

Documentation: state of the union

Community Outreach Track

Ekaterina Gerasimova