nivells.md

% Reflexions sobre les pràctiques % Juan Manuel Gimeno Illa

Organització general

Intentar definir un únic format i contingut de documentació més un conjunt de tecnologies a utilitzar que serveixin per a qualsevol pràctica de qualsevol assignatura, és completament impossible. Cada assignatura, i cada pràctica dins d'una assignatura, té un objectius diferents, un pes diferent en la nota final, uns terminis de realització que incideixen de forma molt important en allò que es demana.

Per tant, s'ha optat per defininir una classificació en tres categories (completament discutibles) que, més que es refereixen al estudiants als que van enfocada l'assignatura / pràctica.

En concret s'han definit tres categories:

• Novell
• Principiant
• Competent

Aquestsa classificació en tres nivells segons els estudiants, d'alguna manera, també es veu reflectida de forma paral·lela en les assignatures:

• A les assignatures pels estudiants novells es fa molt ènfasi en fonaments de la disciplina
• A les assignatures per estudiants principiants es presenten tecnologies i tècniques més concretes
• A les assignatures per estudiants de nivell competents, s'integren coneixements i es realitzen projectes sencers

Per suposat, aquesta associació entre assignatures i alumnes és també discutiple.

Abans d'entrar en els detalls de cada nivell, podriem esmentar us aspectes generals:

Sobre la documentació

Pensant en la documentació a demanar, com a criteris generals, sembla raonable:

• el que es demana ha de tenir rellevància a l'avaluació de la pràctica (principalment si porta temps fer-ho bé) i hauria d'estar relacionat amb els objectius de l'assignatura

  • no demanar coses per demanar
  • no demanar coses que després ni es mirem a l'hora d'avaluar

• és convenient que l'alumne disposi de models i exemples dels elements que ha de tenir una documentació

  • molt sovint la part de la programació sí queda coberta pels molts exemples que es veuen a classe, però no la documentació de les pràctiques

Sobre el llenguatge i/o entorn

L'estudiant haurà de disposar de material (o referències com llibres, tutorials, etc.) sobre el llenguatge de programació i sobre l'entorn que usarà per a realitzar la pràctica (o bé usarà un que ja ha utilitzat a d'altres assignatures).

De fet, durant les primeres setmanes de l'assignatura, quan encara la càrrega de pràctiques és petita, els alumnes podrien dedicar les hores de treball autònom a millorar el seu coneixement de:

• llenguatge de programació
• entorn de treball

Una de les capacitats que més importància tindrà pel futur desenvolupament professional dels estudiants serà la de ser capaços d'adaptar-se als nous llenguatges i entorns. Una vegada es coneixen els fonaments de la programació en un paradigma "imperatiu / estructurat / orientat a objectes", un alumne no novell hauria de ser capaç d'aprende de forma autònoma (òbviament consultant tot allò que necessiti) qualsevol llenguatge d'aquesta familia.

Una vegada fetes aquestes consideracions inicials, passarem a descriure cadascun dels nivells.

Novell

Descripció i objectius

Assignatures de primer(s) curs(os) on l'objectiu no és tan sols aprendre una sèrie de tècniques, sinó adquirir una sèrie de bones pràctiques (o costums) a aplicar en totes les assignatures, i projectes, posteriors.

Un bon costum que caldrà adquiri és no conformar-se amb la primera solució obtinguda. És per això que en la memòria es demana que comentin l'evolució del codi fins arribar a la solució que han donat per bona i han entregat, i solucions alternatives que han considerat.

En quan el codi, la pràctica de no entregar allò que ha funcionat per primer cop, es mostrarà en tenir cura de la indentació del codi, dels noms de variables i funcions, etc. etc.

És molt important que de bon principi els alumnes adquireixin el costum de fer jocs de prova automatitzats del codi. Al principi no cal aprendre cap framework de testing, sinó que simplement fent funcions auxiliars n'hi ha prou.

Per això és molt important que els alumnes disposin d'exemples de codi escrit seguint les directrius que es demanen a les pràctiques i de documentacions que reflecteixin allò que se'ls hi demanarà posteriorment,

Codi

A més de la seva funcionalitat, és important que els alumnes adquireixen un bon estil a l'hora d'escriure. No tan sols un bon estil sobre el producte final, sinó que siguin hàbils en la utilització de l'entorn de programació a utilitzar.

En quan al codi, els aspectes d'estil a destacar podrien ser els següents:

• indentació

• noms variables / funcions

• codi net (esborrar codi comentat que ha estat substituït, etc, etc)

• sobre els comentaris

  • “Code is like humor. When you have to explain it, it’s bad.” – Cory House

  Amb això no volem dir "no comentaris", però primar codi entenidor sense comentaris a codi menys entenidor amb comentari que intenta arreglar-ho.

• ús de les convencions de noms / estructura del llenguatge de programació

• estructuració del codi seguint les normes de l'entorn o de l'eina de construcció usada

I en quan a aspectes més de tècnica de programació

• mínima descomposició funcional (res de funcions quilomètriques)
• tests de prova que han fet per comprovar que funciona com s'espera

Documentació

Una de les principals habilitats que hauran d'adquirir els alumnes és la capacitat de raonar sobre les seves pròpies solucions. I no fer-ho en base a les línies de codi una-a-una, sinó en base a abstraccions com esquemes algorítmics. Per tant sembla sensat demanar a la documentació que expliquin les seves solucions en base a aquests esquemes algorítmics (i no que comentin, línia a línia, el codi que han fet)

• portada
• ús de diagrames informals per explicar dissenys (no cal usar eines de diagramació)
• esquemes algorítmics aplicats
• explicació a nivell de la funcionalitat que realitza cada funció en el context de la descomposició del problema (si la fan ells)
• descripció del principals problemes trobats en solucionar la pràctica
• solucions descartades o alternatives

Eines

No es pot fer una llista d'eines concretes (que només servirà per obrir una guerra de l'estil "emacs vs. vi"), però les eines a utiltzar serien:

• entorn integrat de desenvolupament

  Potser aquí molts discrepareu amb mi, però si pots escrire el codi en un entorn de desenvolupament que entèn part del codi, i que les transformacions que realitza són a nivell de codi (i, per tany, t'obliga a veure aquestes transformacions en termes del llenguatge i no en termes de text), és un guany important. A més, a nivell professional, és l'entorn que es trobaran.

• editor de text (ús del corrector i format del document)

• el control de versions s'ha deixat pel següent nivell però podria considerar-se una qüestió tan bàsica que caldria incorporar-la ja aquí

Principiant

Descripció i objectius

Assignatures en que l'emfasi és més aviat tècnic: l'alumne ha de mostrar que és capaç d'aplicar les tècniques que s'han presentat de forma aduada en un problema concret o àmbit determinat (bases de dades, xarxes, etc.)

Per tant, el contingut de la memòria, haria de centrar-se ser capaç de descriure la seva solució utilitzant els termes i conceptes tècnics adequats de l'assignatura

A més, ha de mostrar solidesa en tots els aspectes que formaven part del nivell anterior

Codi

• ús de les estructures de dades apropiades (amb arrays no se soluciona tot)
• coneixements del llenguatge de programació usat
• descomposició funcional / orientada a objectes
• anàlisi dels costos de les operacions (si aquest és rellevant)
• proves unitàries (ja utilitzant un framework)

Documentació

• diagrames estàndard (classes, seqüència, etc.)
• punts forts i febles de la solució presentada
• descripció (p.e. amb diagrames) de les estructures de dades
• descripció del disseny de les proves (no del seu codi)

Eines

• entorn de desenvolupament
• gestió de dependències i construcció (maven, npm, virtualenv, conda, ...)
• programa de diagramació (o a mà)
• control de versions
• framework de proves

Competent

Descripció i objectius

La diferència amb el nivell anterior és el grau en que l'alumne ha de prendre decisions a l'hora de solucionar la pràctica: en el nivel anterior els enunciats (i, per tant, les solucions) són més tancats i d'un abast més concret. Ara es tracta de projectes informàtics complets on gran part de la feina és de disseny i estructuració dels diferents elements.

Com l'abast del projecte serà més gran, per tal de solucionar-lo, serà necessari descomposar-lo en fases o iteracions:

• aquestes poden estar o no descrites en l'enunciat de la pràctica
• poden donar lloc o no a entregables qualificats

Aquí és fonamental que l'alumne expliqui perquè fa les coses com les fa: quins elements de judici ha aplicat per a fer el que ha fet; quines possibilitats ha considerat i perquè les ha descartat, tot emprant conceptes d'alt nivell (principis de disseny, patrons de disseny, etc.)

Els raonaments hauran de concernir elements més abstractes (p.e. dependències) que meres decisions locals.

Com sempre els nivells anteriors han d'estar completament assolits

Codi

• ús dels patrons de disseny adequats
• eines apropiades al problema a resoldre
• ús de les biblioteques apropiades
• proves a diferents nivells (unitari, integració, funcional, ...)

Documentació

• descripció de les diferents iteracions en que s'ha dividit el projecte
• utilització conceptes adequats
• decisions de disseny alt nivell: arquitectura, patrons
• utilització de diagrames estàndard (p.e. UML)
• alternatives no escollides i raons per les que es van descartar

Eines

• és convenient, ja que el projecte té una envergadura relativament gran, usar un procés iteratiu (amb o sense entregues intermèdies)
• automatització de molts dels processos de gestió del projecte
• integració contínua
• desplegament