On Wed, 8 Aug 2018 15:17:52 -0700 Matthew Zamudio <mattzamudio...@gmail.com> said:
> Xavi, > > I will check out those resources. Thank you. > > As for code, I sadly can't do very much: I'm very experienced with > HTML/CSS, and have some understanding of XML and JSON. Once I have some > defined tasks, however, I can learn what needs to be learned. I'm coming > mostly from a editorial background, but I'm ready to put in work to learn > the nuances of technical writing. Are you willing to learn C (our www has a primer on C too for people that I wrote assuming you know other programming langauges: https://www.enlightenment.org/docs/c/start )? If you are then API docs could be within reach. my take would to start making simple apps like hello world (samples already in our docs and then in our source trees etc. even more). if you think that's not your cup of tea, or you will take a while to do this on the side, then perhaps user documentation would be good as a start? For this you still will need to get your hands dirty and start by downloading, installing efl, enlightenment, terminology etc. so starting on our existing http://www.enlightenment.org is a good start. follow the docs there and ... then contribute. if you think they are missing information, add it. if you think they should be reorganized, do that. it' is a wiki... you can do it just by signing up. if you want to do major re-works. maybe a heads up first on the idea here would be nice. this would maybe give you a soft landing and start on things. it'll be necessary to compile and set up anyway if you want to contribute to more deeper things and it's a good step along the way. i'm sure we have enough typos on our pages too... note that phab.enlightenment.org is really about developers sharing/communicating so it's more loose and typos etc. are less of an issue. wwww.enlightenment.org is i guess the "official print" front end and where presentation is important. there is a wiki syntax sample page on https://www.enlightenment.org/wiki/syntax ... maybe then get things compiled. installed etc. install some efl apps. install enlightenment and use it day to day. then get more curious. one aspect that could do with docs that won't involves programming but can leverage off experience with css/html might be themes. conceptually there are similarities with edje in some ways being far better or more convenient than css/html and in other ways more limited (it is limited as its job it to provide ui elements with styling and animation, not entire documents). writing some really good guides on how to do themes (edje files) with examples etc. might also be a nice soft landing and will actually let you explore a part of efl/e that is user-accessible without needing a whole compiler/development suite. we can help guide you here as well and point you to starters etc. my take would be that api docs would require knowledge of C and being able to dig through code to fill out the docs with pre/post conditions and understand the usage intentions of the api etc. and might be a more advanced topic for a doc person once they get the coding skills under their belt? i'm not saying not to do it, just to schedule it later once you have learned some of this (e.g. C) and written some sample apps etc. > Best, > Matt > > On Wed, Aug 8, 2018 at 3:13 PM, Matthew Zamudio <mattzamudio...@gmail.com> > wrote: > > > Hi Bryce, > > > > For now, I'm most interested in working with: > > > > - API documentation > > - Tutorials > > - End-user documentation > > > > Based on the name at least, high level projects should probably wait until > > I complete some lower level tasks. > > > > I will most likely require some guidance with API, but I can teach myself > > a lot once I have a definite task and direction. As for tutorials and > > end-user documentation, I should be able to handle those on my own. > > > > Best, > > Matt > > > > On Wed, Aug 8, 2018 at 3:03 PM, Bryce Harrington < > > br...@bryceharrington.org> wrote: > > > >> On Wed, Aug 08, 2018 at 10:38:53AM -0700, Matthew Zamudio wrote: > >> > Hi all! > >> > > >> > My name is Matt Zamudio and I'm very new here. I hope to help out at > >> > Enlightenment with documentation. Currently, I work as a writer and > >> editor > >> > at an online publishing website in the San Francisco Bay Area. I'm > >> looking > >> > to transition from the journalism and editorial fields to technical > >> > writing, and figure this is a good place to start. > >> > > >> > Please let me know if there is anything I can immediately get started > >> on. > >> > Otherwise, I'll continue my correspondence with Xavi and go from there. > >> > > >> > Looking forward to working with all of you. > >> > > >> > Best, > >> > Matt Zamudio > >> > >> Hi Matt, > >> > >> There are four general categories of documentation work Enlightenment > >> and EFL need presently, at least, that I've seen: API documentation, > >> tutorials, high level project/architectural, and end user documentation. > >> > >> Each of these categories is broad with many subcategories of work items > >> within them. Some areas have gotten more attention than others, some > >> have more urgent need of attention, some require deeper experience with > >> the project than others. Some areas have people who can give guidance, > >> others you'd be more on your own to figure out what's needed. > >> > >> What are your personal druthers regarding the above? It'd help in > >> getting you pointed in the direction you want to go. > >> > >> Bryce > >> > >> ------------------------------------------------------------ > >> ------------------ > >> Check out the vibrant tech community on one of the world's most > >> engaging tech sites, Slashdot.org! http://sdm.link/slashdot > >> _______________________________________________ > >> enlightenment-devel mailing list > >> enlightenment-devel@lists.sourceforge.net > >> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel > >> > > > > > ------------------------------------------------------------------------------ > Check out the vibrant tech community on one of the world's most > engaging tech sites, Slashdot.org! http://sdm.link/slashdot > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel > -- ------------- Codito, ergo sum - "I code, therefore I am" -------------- Carsten Haitzler - ras...@rasterman.com ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
